获取通知

以下代码演示如何从符号处理程序中获取和报告详细状态信息,以搜索和加载模块和相应的符号文件。

许多熟悉 WinDbg 调试器的命令可能会记住一个名为“!sym noisy”的命令。 用户使用此命令来确定 WinDbg 是还是无法加载符号文件的原因。 它显示符号处理程序尝试的所有内容的详细列表。

对于开发 DbgHelp 符号处理程序的客户端的任何人,也可以使用同一列表。

首先,使用 SYMOPT_DEBUG 调用 SymSetOptions。 这会导致 DbgHelp 打开调试通知。

调用 SymInitialize 后,使用 SymRegisterCallback64 注册 DbgHelp 每当发生有趣的事件时将调用的回调函数。 在此示例中,回调函数称为 SymRegisterCallbackProc64。 符号回调函数将传递一系列操作代码,这些代码可以根据类型进行处理。 在此示例中,我们仅处理 CBA_EVENT 操作代码。 此函数传递一个字符串,其中包含有关加载符号过程中发生的事件的详细信息。 此事件可以是从尝试读取可执行文件中的数据到符号文件的成功位置的任何内容。 SymRegisterCallbackProc64 显示该字符串并返回 TRUE

重要

请确保将 FALSE 返回到未处理的每个操作代码,否则可能会遇到未定义的行为。 有关所有操作代码及其含义的列表,请参阅 SymRegisterCallbackProc64

 

注册回调后,调用 SymLoadModuleEx 即可加载命令行中指定的模块。

最后,在退出之前调用 SymCleanup

#include <windows.h>
#include <stdio.h>
#include <tchar.h>

#ifdef UNICODE
 #define DBGHELP_TRANSLATE_TCHAR
#endif
#include <dbghelp.h>

// Here is an implementation of a Symbol Callback function.

BOOL 
CALLBACK 
SymRegisterCallbackProc64(
    __in HANDLE hProcess,
    __in ULONG ActionCode,
    __in_opt ULONG64 CallbackData,
    __in_opt ULONG64 UserContext
    )
{
    UNREFERENCED_PARAMETER(hProcess);
    UNREFERENCED_PARAMETER(UserContext);
    
    PIMAGEHLP_CBA_EVENT evt;

    // If SYMOPT_DEBUG is set, then the symbol handler will pass
    // verbose information on its attempt to load symbols.
    // This information be delivered as text strings.
    
    switch (ActionCode)
    {
    case CBA_EVENT:
        evt = (PIMAGEHLP_CBA_EVENT)CallbackData;
        _tprintf(_T("%s"), (PTSTR)evt->desc);
        break;

    // CBA_DEBUG_INFO is the old ActionCode for symbol spew.
    // It still works, but we use CBA_EVENT in this example.
#if 0
    case CBA_DEBUG_INFO:
        _tprintf(_T("%s"), (PTSTR)CallbackData);
        break;
#endif

    default:
        // Return false to any ActionCode we don't handle
        // or we could generate some undesirable behavior.
        return FALSE;
    }

    return TRUE;
}

// Main code.

int __cdecl
#ifdef UNICODE
_tmain(
#else
main(
#endif
    __in int argc,
    __in_ecount(argc) PCTSTR argv[]
    )
{
    BOOL status;
    int rc = -1;
    HANDLE hProcess;
    DWORD64 module;
    
    if (argc < 2)
    {
        _tprintf(_T("You must specify an executable image to load.\n"));
        return rc;
    }

    // If we want to se debug spew, we need to set this option.
        
    SymSetOptions(SYMOPT_DEBUG);
    
    // We are not debugging an actual process, so lets use a placeholder
    // value of 1 for hProcess just to ID these calls from any other
    // series we may want to load.  For this simple case, anything will do.
    
    hProcess = (HANDLE)1;
    
    // Initialize the symbol handler.  No symbol path.  
    // Just let dbghelp use _NT_SYMBOL_PATH
    
    status = SymInitialize(hProcess, NULL, false);
    if (!status)
    {
        _tprintf(_T("Error 0x%x calling SymInitialize.\n"), GetLastError());
        return rc;
    }
     
    // Now register our callback.
    
    status = SymRegisterCallback64(hProcess, SymRegisterCallbackProc64, NULL);
    if (!status)
    {
        _tprintf(_T("Error 0x%x calling SymRegisterCallback64.\n"), GetLastError());
        goto cleanup;
    }
    
    // Go ahead and load a module for testing.
    
    module = SymLoadModuleEx(hProcess,  // our unique id
                             NULL,      // no open file handle to image
                             argv[1],   // name of image to load
                             NULL,      // no module name - dbghelp will get it
                             0,         // no base address - dbghelp will get it
                             0,         // no module size - dbghelp will get it
                             NULL,      // no special MODLOAD_DATA structure
                             0);        // flags
    if (!module)
    {
        _tprintf(_T("Error 0x%x calling SymLoadModuleEx.\n"), GetLastError());
        goto cleanup;
    }
    rc = 0;
    
cleanup:
    SymCleanup(hProcess);
    
    return rc;    
}

NULL 指定为 SymInitialize 的第二个参数表示符号处理程序应使用默认搜索路径来查找符号文件。 有关符号处理程序如何查找符号文件或应用程序如何指定符号搜索路径的详细信息,请参阅 符号路径

运行此程序会显示如何处理符号路径。 当 DbgHelp 浏览符号路径以查找符号文件时,它反复调用 SymRegisterCallbackProc64 ,后者又显示 DbgHelp 传递的以下字符串。

d:\load.exe c:\home\dbghelp.dll
DBGHELP: No header for c:\home\dbghelp.dll.  Searching for image on disk
DBGHELP: c:\home\dbghelp.dll - OK
DBGHELP: .\dbghelp.pdb - file not found
DBGHELP: .\dll\dbghelp.pdb - file not found
DBGHELP: .\symbols\dll\dbghelp.pdb - file not found
DBGHELP: .\symbols\dll\dbghelp.pdb - file not found
DBGHELP: cache*c:\symbols\dbghelp.pdb - file not found
DBGHELP: cache*c:\symbols\dll\dbghelp.pdb - file not found
DBGHELP: cache*c:\symbols\symbols\dll\dbghelp.pdb - file not found
DBGHELP: d:\nt.binaries.amd64chk\symbols.pri\dbg\dbghelp.pdb - file not found
DBGHELP: dbghelp - private symbols & lines
         dbghelp.pdb