Získávání oznámení

Následující kód ukazuje, jak podrobně získávat a hlásit stavové informace z obslužné rutiny symbolů týkající se hledání a načítání modulů a jejich odpovídajících souborů symbolů.

Mnoho lidí, kteří znají ladicí program WinDbg, si možná pamatuje příkaz s názvem "!sym noisy". Tento příkaz používá uživatel k určení, proč WinDbg načítá nebo nenahrává soubory symbolů. Zobrazuje rozšířený seznam všeho, co zpracovávač symbolů zkouší.

Stejný výpis je také k dispozici každému, kdo vyvíjí klienta pro symbolový zpracovatel DbgHelp.

Nejprve volejte SymSetOptions s SYMOPT_DEBUG. To způsobí, že DbgHelp zapne oznámení ladění.

Po volání SymInitializepoužijte SymRegisterCallback64 k zaregistrování funkce zpětného volání, kterou DbgHelp zavolá pokaždé, když dojde k relevantní události. V tomto příkladu se funkce zpětného volání nazývá SymRegisterCallbackProc64. Funkce zpětného volání symbolu obdrží různé kódy akcí, které mohou zpracovat podle jejich typu. V tomto příkladu zpracováváme pouze kód akce CBA_EVENT. Tato funkce předá řetězec obsahující podrobné informace o události, ke které došlo při načítání symbolu. Tato událost může být cokoli od pokusu o načtení dat ve spustitelném obrázku do úspěšného umístění souboru symbolů. SymRegisterCallbackProc64 zobrazí tento řetězec a vrátí TRUE.

Důležitý

Nezapomeňte vrátit FALSE každému kódu akce, který nezpracováváte, jinak se může vyskytnout nedefinované chování. Seznam všech kódů akcí a jejich důsledků najdete v SymRegisterCallbackProc64.

 

Teď, když je zpětné volání zaregistrováno, je čas načíst modul zadaný na příkazovém řádku voláním SymLoadModuleEx.

Nakonec před ukončením volejte 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;    
}

Zadáním NULL jako druhým parametrem SymInitialize znamená, že obslužná rutina symbolů by měla k vyhledání souborů symbolů použít výchozí cestu hledání. Podrobné informace o tom, jak obslužná rutina symbolů vyhledá soubory symbolů nebo jak může aplikace určit cestu hledání symbolů, najdete v tématu Cesty symbolů.

Spuštěním tohoto programu se dozvíte, jak se zpracovává cesta symbolu. Vzhledem k tomu, že DbgHelp prochází symbolickou cestu, aby našel soubor symbolů, opakovaně volá SymRegisterCallbackProc64, čímž se zobrazí následující řetězce předávané 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