microsoft/windbg-libraries

Libraries for extending WinDbg and its underlying components.

Introduction

This is a collection of libraries for extending WinDbg.

Build and Test

To build on any of these libraries you can download the files locally or add our Nuget package to your project.

Contribute

Contributions are welcome, you can:

• Submit bugs and help us verify fixes.
• Submit pull requests for bug fixes and features and discuss existing proposals
• Ask questions, open an issue and prefix the issue title with [Question]. See Question tag for already-opened questions.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Please refer to Contribution Guidelines for more details.

License

Code licensed under the MIT License.

windbg-libraries's Issues

DbgModelClientEx.h IDataModelManager4, IDeconstructableConcept and IFilteredNamespacePropertyToken Don't Exist

The IDataModelManager4 and IDeconstructableConcept COM interfaces do not exist anywhere and the client library cannot compile. I have to replace the manager with the only existing version (2) inside DbgModel.h and completely comment out the IDeconstructableConcept code in the client to get it to compile. Would be great to get this fixed asap since it makes the client library unusable.

Thanks!

Is there are a extension for stl?

Hello, When I use windbg, I found dump the content about stl is often make me pain. like std::map. I guess !std_map and !stl maybe could help me a little, But seems its is been deprecated, so is there another plan for this(etc, extension or command..). Thx.

• https://learn.microsoft.com/en-us/windows-hardware/drivers/debuggercmds/-stl

Accessing a child symbol by std::wstring results in infinite recursion

Example snippet:

ClientEx::Module hostModule{ hostContext, moduleName };
ClientEx::Symbol functionSymbol = hostModule.FindSymbol(functionName);

return Object::FromSymbol(functionSymbol.Children()[variableName]);

TSymChild SymbolChildrenRef::operator[](_In_ const std::wstring& fieldName) const attempts to recursively call TSymChild operator[](_In_z_ const wchar_t *childName). Since the latter is not const, the former is called, implicitly creating a new std::wstring, and execution recurses infinitely.

[Question] Calling native functions on models from a debug session

Hello,

Is it possible to call functions on an object from a debug session? I've got objects from the top frame of the callstack and can get their type, iterate over the native fields, etc, but I haven't found a way to call or even list all the functions on these objects.

By modifying FromExpressionEvaluation to take in a context model for the "this" pointer I'm able to successfully evaluate a function name (e.g. "utf8_str") against a specific object and the api returns that it is a function and I can query its return type but I'm not sure how I can then execute it and inspect what it returns.

Ultimately what I'm trying to do is create an ExtensionModel for a class in the target and be able to call a function so I can make a display string using its result. Sorry if this is more DbgEng / DbgModel specific than just the c++ wrapper library but there's very little information on how to use all these debugging apis.

Thanks.

Unresolved external when using ExtensionModel::AddMethod

Implementation of Debugger::DataModel::ClientEx::details::RegularUnpacker<TTuple, i, remaining>::UnpackInto is not compiled when __DBGMODEL_TEST_H__ is not defined

Constructing a TypeSignature by signature and module name does not work as expected

I found that my TypeSignatureExtension extension model was not matching the type successfully when constructed with the signature and module name. This overload is calling IDebugHostSymbols::CreateTypeSignatureForModuleRange and passing nullptr for the minimum and maximum version parameters. Though that call succeeds I don't think the actual signature is valid, at least it is not matching as expected.

The expectation seems to be that calling CreateTypeSignatureForModuleRange but not providing a version range should produce an equivalent signature object to calling IDebugHostSymbols::CreateTypeSignature with the signature and an IDebugHostModule*. The documentation for CreateTypeSignatureForModuleRange and the referenced CreateModuleSignature suggest that this should work. Could this be a bug in DbgModel?

If I update the constructor to first get the IDebugHostModule using IDebugHostSymbols::FindModuleByName and pass that to CreateTypeSignature, everything works as expected.

The referenced constructor overload:

// TypeSignature(signature, moduleName)
//
// Creates a type signature for a type whose name and module name matches the supplied string signatures.
//
template<typename TStr1, typename TStr2,
    typename = std::enable_if_t<!std::is_same_v<typename std::decay_t<TStr2>, Module>>>
    TypeSignature(_In_ TStr1&& signature, _In_ TStr2&& moduleName)
{
    const wchar_t *pSignature = Details::ExtractString(signature);
    const wchar_t *pModuleName = Details::ExtractString(moduleName);
    ComPtr<IDebugHostSymbols> spHostSym;
    ClientEx::CheckHr(ClientEx::GetHost()->QueryInterface(IID_PPV_ARGS(&spHostSym)));
    ClientEx::CheckHr(spHostSym->CreateTypeSignatureForModuleRange(pSignature, 
        pModuleName, 
        nullptr,
        nullptr,
        &m_spTypeSignature));
}

The CPP sample fails to compile with VS 2019 tools (142)

The call to Details::ExtractString fails to compile, but it does compile if "Details" is removed.
Also bad_alloc is not found