Wie schreibt man einen custom native visualizer-DLL für Visual Studio 2012-debugger?

Was nötig ist zum schreiben eines benutzerdefinierten native visualizer-DLL in C++ für Visual Studio 2012-debugger? Ich will angezeigter Wert kann nur berechnet werden, aus einer Klasse/struct on-demand-also eine native visualizer-DLL ist erforderlich. Visual Studio 2012 verwendet eine neue Methode für die Umsetzung von native-Visualisierungen genannt Natvis. Ab diesem Zeitpunkt, es gibt sehr wenig richtige Informationen auf Natvis und vor allem auf die Verwendung Natvis zu nennen visualizer-DLL. Die DLL wird die Berechnung einer display-saite, basierend auf der Klasse/struct member-Werte.

code.msdn.microsoft.com/windowsdesktop/...
Das ist eine große natvis post, die ich auch weiter unten erwähnt, es muss aber nicht ein Wort über das schreiben eines benutzerdefinierten native visualizer dll. Ich werde großzügig sein und sagen, dass es zu früh das Spiel für die Microsoft zur Abdeckung des gesamten Themas.

InformationsquelleAutor BSalita | 2012-07-18

c++debugging visual-studio-2012 visualizer

Hier ist der C++ - code, umfasst das Add-in-DLL. Ich benannte die Datei NatvisAddIn.cpp und das Projekt erstellt 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;
}

Hier ist die .natvis-Datei, die Visual Studio 2012-debugger verwendet, um den Wert anzuzeigen. Platzieren Sie es in einem .natvis-Datei. Ich nannte es NatvisAddIn.natvis. Die Datei weist VS-2012-debugger zu nennen NatvisAddIn.dll. Die dll enthält zwei visualizer-Methode ruft; MyClassFormatter formatieren MyClass und MyStructFormatter formatieren MyStruct. Der debugger zeigt die Methode der formatierte Wert in der Auto -, Uhren-oder tooltip-Anzeige für jede Instanz des angegebenen Typs (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>

Sowohl die kompilierte NatvisAddIn.dll Datei und die NatvisAddIn.natvis-Dateien in einem der folgenden drei Orte:

%VSINSTALLDIR%\Common7\Packages\Debugger\Visualizers (requires admin access)

%USERPROFILE%\My Documents\Visual Studio 2012\Visualizers\

VS extension folders

Müssen Sie sicherstellen, dass die folgenden Registrierungsschlüssel vorhanden ist und den Wert 1:

[HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0_Config\Debugger]

"EnableNatvisDiagnostics"=dword:00000001

Wenn alles gut geht, werden Sie sehen, natvis-Nachrichten werden in die Visual Studio-debugger-Ausgabefenster. Die Nachrichten zeigen wird, ob Natvis war in der Lage zu analysieren .natvis-Dateien. Die Ergebnisse der Analyse jeder .natvis-Datei wird in Ausgabe-Fenster. Wenn etwas falsch ist, verwenden Sie den Befehl "dumpbin/exports ", um zu überprüfen, dass die DLL-Methoden' Namen sind genau das passende .navis Dateityp=. Auch stellen Sie sicher, dass die aktuellen .dll-und .natvis-Dateien in das entsprechende Verzeichnis kopiert.

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.

Test-Programm:

#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;
}

Informationen Ressourcen:

\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

Danke für die Nachfrage. Es gab ein paar downvotes vielleicht, weil ich noch nicht gefüllt in allen stubs. Ich war das hinzufügen in Echtzeit. Ich habe gelernt, dass ich sollte den post auf der ersten post, wenn möglich. Der Beitrag ist nun vollständig, es sind also viele upvotes häufen.
Erstmal vielen Dank für Entsendung es, aber ich glaube nicht, dass das funktionieren würde für 64-bit-apps. (DWORD verwendet wird, zur Adresse, zum Beispiel, und andere Dinge). Auch wie würde man gehen, um ein plugin, das irgendwie beschäftigt sich mit der 32-bit - /64-bit-code, der auf der anderen Seite?
Gute Frage. Sorry, ich weiß nicht. Ich Frage mich, ob es gibt eine weitere Komplikation, da Visual Studio-debugger ist ein 32-bit-Prozess. Wer?
Sie können die Kombination von GetRealAddress und ReadDebuggeeMemoryEx Umgang mit 64-bit-Adressen.
Ich kann nicht ankommen dieses zu wirken, wenn ich zog die class und struct in einer anderen DLL
Kann ein Pfad zur DLL ein, die Umgebungsvariable es? Was ist die syntax? Schon versucht %ENV_VAR% und ${ENV_VAR}, kein Glück.

InformationsquelleAutor BSalita

Für 64-bit-version Debuggen, sollten folgende Einträge verwendet werden:

auto realAddress = pHelper->GetRealAddress(pHelper);
pHelper->ReadDebuggeeMemoryEx(pHelper, realAddress, sizeof(MyClass), &c, &nGot );

Zur vorherigen Beispiel, die 64bit version könnte wie folgt Aussehen:

#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;
}

InformationsquelleAutor k4hvd1

0

Ich brauche eine Klarstellung bezüglich Suchpfad(en) gesucht werden für das laden der oben genannten "NatvisAddIn.dll". Lassen Sie mich versuchen zu erklären, durch die Erweiterung des obigen Beispiel

Zu visualisieren, meine benutzerdefinierte C++ - Klassen-Objekt(sagen wir mal MyCustomeType), muss ich anrufen einige zusätzliche APIs (zum berechnen der Anzeige-Zeichenfolge für MyCustomeType) in der Implementierung der Funktion(sagen MyClassFormatter), der erwähnt wird im "Export" - Attribut des "DisplayString" XML.

Aufruf dieser zusätzliche APIs erstellen Sie eine Bibliothek/dll-Abhängigkeit auf die oben genannten "NatvisAddIn.dll". Wenn diese zusätzliche Abhängigkeit ist nur ein oder zwei die Bibliothek, ich kann die Bibliothek an der gleichen Stelle, wo NatvisAddIn.dll vorhanden ist. Allerdings, in meinem Fall die Abhängigkeit enthält eine lange Kette von Bibliotheken.

Kann jemand empfehlen, mir einige elegante Weise zu lösen, die Abhängigkeit, ohne zu ziehen, die komplette Kette von Bibliotheken in %USERPROFILE%\My Documents\Visual Studio 2012\Visualizer-Ordner?

Zur demonstration der meine, lassen Sie uns betrachten Sie das folgende Abhängigkeitsstruktur:
NatvisAddIn.dll
ein.dll

a1.dll
a2.dll
a3.dll

Kopierte ich die a.dll an derselben Stelle, wo NatvisAddIn.dll. Es ist abhängig von dlls (a1, a2 und a3) vorhanden sind, an der Position, die Hinzugefügt werden, um die PATH-variable. Wenn ich versuche zu visualisieren MyCustomeType-Objekt in visual studio-debugger, der natvis diagonostic geben die folgende Fehlermeldung im Ausgabefenster

Natvis: C:\Users\myUser\Documents\Visual Studio 2017\Visualizer\mydata.natvis(9,6): Error: Failed to load addin aus C:\Users\myuser\Documents\Visual Studio 2017\Visualizers\NatvisAddIn.dll für Typ MyCustomeType: : Das angegebene Modul konnte nicht gefunden werden.

Mein Verständnis für oben genannten Fehler, der visual studio-debugger nicht in der Lage war zu lösen, Abhängigkeit von a.dll (a1, a2 und a3) und damit es nicht geladen werden konnte NatvisAddIn.dll

Als ich versuchte zu verwenden a.dll in meinem testApplication und berechnen Sie die DisplayString für MyCustomeType, Abhängigkeit bekommen beheben, a.dll ist geladen und ich bekomme das erwartet string, ohne Sie zu kopieren a1.dll, a2.dll und a3.dll. die abhängige dll behoben werden/abgeholt von Fenster-variable PATH. Aber Im Fall von visual studio-debugger, abhängige DLL NICHT gelöst werden, von PATH-variable.

Als identifiziert wird, hängt-tool, einige dlls, die nicht gelöst werden, indem debugger sind:

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

Einige dieser dll vorhanden sind visual studio-installation, andere sind in c:\windows\WinSxS

Habe ich versucht, meine auf visual studio 2012 und visual studio 2017. Ich landete in derselben Ausgabe mit der visual studios.

InformationsquelleAutor Santosh Chauhan

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.