drwtsn32.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ModuleData
struct	ThreadData
class	DumpData

Macros
#define	NEWLINE   "\r\n"

Typedefs
typedef std::vector< ModuleData >	ModuleList
typedef std::map< DWORD, ThreadData >	ThreadMap

Functions
void	xfprintf (FILE *stream, const char *fmt,...)
bool	UpdateFromEvent (DEBUG_EVENT &evt, DumpData &data)
void	PrintSystemInfo (FILE *output, DumpData &data)
void	BeginStackBacktrace (DumpData &data)
void	PrintStackBacktrace (FILE *output, DumpData &data, ThreadData &thread)
void	EndStackBacktrace (DumpData &data)

Macro Definition Documentation

NEWLINE

#define NEWLINE   "\r\n"

Definition at line 53 of file drwtsn32.h.

Typedef Documentation

ModuleList

typedef std::vector<ModuleData> ModuleList

Definition at line 33 of file drwtsn32.h.

ThreadMap

typedef std::map<DWORD, ThreadData> ThreadMap

Definition at line 34 of file drwtsn32.h.

Function Documentation

BeginStackBacktrace()

void BeginStackBacktrace

(

DumpData &

data

)

Definition at line 14 of file stacktrace.cpp.

{
    DWORD symOptions = SymGetOptions();
    symOptions |= SYMOPT_UNDNAME | SYMOPT_AUTO_PUBLICS | SYMOPT_DEFERRED_LOADS;
    SymSetOptions(symOptions);
    SymInitialize(data.ProcessHandle, NULL, TRUE);
}

Referenced by PrintBugreport().

EndStackBacktrace()

void EndStackBacktrace

(

DumpData &

data

)

Definition at line 22 of file stacktrace.cpp.

{
    SymCleanup(data.ProcessHandle);
}

Referenced by PrintBugreport().

PrintStackBacktrace()

void PrintStackBacktrace	(	FILE *	output,
		DumpData &	data,
		ThreadData &	thread
	)

Definition at line 36 of file stacktrace.cpp.

{
    DWORD MachineType;
    STACKFRAME64 StackFrame = { { 0 } };
 
    StackFrame.AddrPC.Mode = AddrModeFlat;
    StackFrame.AddrReturn.Mode = AddrModeFlat;
    StackFrame.AddrFrame.Mode = AddrModeFlat;
    StackFrame.AddrStack.Mode = AddrModeFlat;
    StackFrame.AddrBStore.Mode = AddrModeFlat;
 
 
#if defined(_M_IX86)
    MachineType = IMAGE_FILE_MACHINE_I386;
    StackFrame.AddrPC.Offset = thread.Context.Eip;
    StackFrame.AddrStack.Offset = thread.Context.Esp;
    StackFrame.AddrFrame.Offset = thread.Context.Ebp;
#elif defined(_M_AMD64)
    MachineType = IMAGE_FILE_MACHINE_AMD64;
    StackFrame.AddrPC.Offset = thread.Context.Rip;
    StackFrame.AddrStack.Offset = thread.Context.Rsp;
    StackFrame.AddrFrame.Offset = thread.Context.Rbp;
#elif defined(_M_ARM)
    MachineType = IMAGE_FILE_MACHINE_ARMNT;
    StackFrame.AddrPC.Offset = thread.Context.Pc;
    StackFrame.AddrStack.Offset = thread.Context.Sp;
    StackFrame.AddrFrame.Offset = thread.Context.R11;
#elif defined(_M_ARM64)
    MachineType = IMAGE_FILE_MACHINE_ARM64;
    StackFrame.AddrPC.Offset = thread.Context.Pc;
    StackFrame.AddrStack.Offset = thread.Context.Sp;
    StackFrame.AddrFrame.Offset = thread.Context.u.s.Fp;
#else
#error "Unknown architecture"
#endif
 
#define STACKWALK_MAX_NAMELEN   512
    char buf[sizeof(SYMBOL_INFO) + STACKWALK_MAX_NAMELEN] = {0};
    SYMBOL_INFO* sym = (SYMBOL_INFO *)buf;
    IMAGEHLP_MODULE64 Module = { 0 };
    LONG RecursionDepth = 0;
    sym->SizeOfStruct = sizeof(sym);
 
    /* FIXME: dump x bytes at PC here + disasm it! */
 
    xfprintf(output, NEWLINE "*----> Stack Back Trace <----*" NEWLINE NEWLINE);
    bool first = true;
    while (StackWalk64(MachineType, data.ProcessHandle, thread.Handle, &StackFrame, &thread.Context,
                       NULL, SymFunctionTableAccess64, SymGetModuleBase64, NULL))
    {
        if (StackFrame.AddrPC.Offset == StackFrame.AddrReturn.Offset)
        {
            if (RecursionDepth++ > STACK_MAX_RECURSION_DEPTH)
            {
                xfprintf(output, "- Aborting stackwalk -" NEWLINE);
                break;
            }
        }
        else
        {
            RecursionDepth = 0;
        }
 
        if (first)
        {
            xfprintf(output, "FramePtr ReturnAd Param#1  Param#2  Param#3  Param#4  Function Name" NEWLINE);
            first = false;
        }
 
        Module.SizeOfStruct = sizeof(Module);
        DWORD64 ModBase = SymGetModuleBase64(data.ProcessHandle, StackFrame.AddrPC.Offset);
        if (!ModBase || !SymGetModuleInfo64(data.ProcessHandle, ModBase, &Module))
            strcpy(Module.ModuleName, "<nomod>");
 
        memset(sym, '\0', sizeof(*sym) + STACKWALK_MAX_NAMELEN);
        sym->SizeOfStruct = sizeof(*sym);
        sym->MaxNameLen = STACKWALK_MAX_NAMELEN;
        DWORD64 displacement = 0;
 
        if (!StackFrame.AddrPC.Offset || !SymFromAddr(data.ProcessHandle, StackFrame.AddrPC.Offset, &displacement, sym))
            strcpy(sym->Name, "<nosymbols>");
 
        xfprintf(output, "%p %p %p %p %p %p %s!%s +0x%I64x" NEWLINE,
                 (ULONG_PTR)StackFrame.AddrFrame.Offset, (ULONG_PTR)StackFrame.AddrPC.Offset,
                 (ULONG_PTR)StackFrame.Params[0], (ULONG_PTR)StackFrame.Params[1],
                 (ULONG_PTR)StackFrame.Params[2], (ULONG_PTR)StackFrame.Params[3],
                 Module.ModuleName, sym->Name, displacement);
    }
 
    UCHAR stackData[0x10 * 10];
    SIZE_T sizeRead;
#if defined(_M_IX86)
    ULONG_PTR stackPointer = thread.Context.Esp;
#elif defined(_M_AMD64)
    ULONG_PTR stackPointer = thread.Context.Rsp;
#elif defined(_M_ARM) || defined(_M_ARM64)
    ULONG_PTR stackPointer = thread.Context.Sp;
#else
#error Unknown architecture
#endif
    if (!ReadProcessMemory(data.ProcessHandle, (PVOID)stackPointer, stackData, sizeof(stackData), &sizeRead))
        return;
 
    xfprintf(output, NEWLINE "*----> Raw Stack Dump <----*" NEWLINE NEWLINE);
    for (size_t n = 0; n < sizeof(stackData); n += 0x10)
    {
        char HexData1[] = "?? ?? ?? ?? ?? ?? ?? ??";
        char HexData2[] = "?? ?? ?? ?? ?? ?? ?? ??";
        char AsciiData1[] = "????????";
        char AsciiData2[] = "????????";
 
        for (size_t j = 0; j < 8; ++j)
        {
            size_t idx = j + n;
            if (idx < sizeRead)
            {
                HexData1[j * 3] = ToChar(stackData[idx] >> 4);
                HexData1[j * 3 + 1] = ToChar(stackData[idx] & 0xf);
                AsciiData1[j] = isprint(stackData[idx]) ? stackData[idx] : '.';
            }
            idx += 8;
            if (idx < sizeRead)
            {
                HexData2[j * 3] = ToChar(stackData[idx] >> 4);
                HexData2[j * 3 + 1] = ToChar(stackData[idx] & 0xf);
                AsciiData2[j] = isprint(stackData[idx]) ? stackData[idx] : '.';
            }
        }
 
        xfprintf(output, "%p %s - %s  %s%s" NEWLINE, stackPointer+n, HexData1, HexData2, AsciiData1, AsciiData2);
    }
}

Referenced by PrintThread().

PrintSystemInfo()

void PrintSystemInfo	(	FILE *	output,
		DumpData &	data
	)

Definition at line 56 of file sysinfo.cpp.

{
    SYSTEMTIME LocalTime;
    GetLocalTime(&LocalTime);
    xfprintf(output, NEWLINE "ReactOS " KERNEL_VERSION_STR " DrWtsn32" NEWLINE NEWLINE);
    xfprintf(output, "Application exception occurred:" NEWLINE);
    xfprintf(output, "    App: %ls (pid=%d, tid=0x%x)" NEWLINE, data.ProcessName.c_str(), data.ProcessID, data.ThreadID);
    xfprintf(output, "    When: %d/%d/%d @ %02d:%02d:%02d.%d" NEWLINE,
             LocalTime.wDay, LocalTime.wMonth, LocalTime.wYear,
             LocalTime.wHour, LocalTime.wMinute, LocalTime.wSecond, LocalTime.wMilliseconds);
 
    xfprintf(output, "    First chance: %u" NEWLINE, data.ExceptionInfo.dwFirstChance);
    EXCEPTION_RECORD& Record = data.ExceptionInfo.ExceptionRecord;
    xfprintf(output, "    Exception number: 0x%08x (%s)" NEWLINE, Record.ExceptionCode, Exception2Str(Record.ExceptionCode));
    xfprintf(output, "    Exception flags: 0x%08x" NEWLINE, Record.ExceptionFlags);
    xfprintf(output, "    Exception address: %p" NEWLINE, Record.ExceptionAddress);
    if (Record.NumberParameters)
    {
        xfprintf(output, "    Exception parameters: %u" NEWLINE, Record.NumberParameters);
        for (DWORD n = 0; n < std::min<DWORD>(EXCEPTION_MAXIMUM_PARAMETERS, Record.NumberParameters); ++n)
        {
            xfprintf(output, "      Parameter %u: 0x%p" NEWLINE, n, Record.ExceptionInformation[n]);
        }
    }
 
    char Buffer[MAX_PATH];
    DWORD count = sizeof(Buffer);
    xfprintf(output, NEWLINE "*----> System Information <----*" NEWLINE NEWLINE);
    if (GetComputerNameA(Buffer, &count))
        xfprintf(output, "    Computer Name: %s" NEWLINE, Buffer);
    count = sizeof(Buffer);
    if (GetUserNameA(Buffer, &count))
        xfprintf(output, "    User Name: %s" NEWLINE, Buffer);
 
 
    PVOID SMBiosBuf;
    PCHAR DmiStrings[ID_STRINGS_MAX] = { 0 };
    SMBiosBuf = LoadSMBiosData(DmiStrings);
    if (SMBiosBuf)
    {
        if (DmiStrings[BIOS_VENDOR])
            xfprintf(output, "    BIOS Vendor: %s" NEWLINE, DmiStrings[BIOS_VENDOR]);
        if (DmiStrings[BIOS_VERSION])
            xfprintf(output, "    BIOS Version: %s" NEWLINE, DmiStrings[BIOS_VERSION]);
        if (DmiStrings[BIOS_DATE])
            xfprintf(output, "    BIOS Date: %s" NEWLINE, DmiStrings[BIOS_DATE]);
        if (DmiStrings[SYS_VENDOR])
            xfprintf(output, "    System Manufacturer: %s" NEWLINE, DmiStrings[SYS_VENDOR]);
        if (DmiStrings[SYS_FAMILY])
            xfprintf(output, "    System Family: %s" NEWLINE, DmiStrings[SYS_FAMILY]);
        if (DmiStrings[SYS_PRODUCT])
            xfprintf(output, "    System Model: %s" NEWLINE, DmiStrings[SYS_PRODUCT]);
        if (DmiStrings[SYS_VERSION])
            xfprintf(output, "    System Version: %s" NEWLINE, DmiStrings[SYS_VERSION]);
        if (DmiStrings[SYS_SKU])
            xfprintf(output, "    System SKU: %s" NEWLINE, DmiStrings[SYS_SKU]);
        if (DmiStrings[BOARD_VENDOR])
            xfprintf(output, "    Baseboard Manufacturer: %s" NEWLINE, DmiStrings[BOARD_VENDOR]);
        if (DmiStrings[BOARD_NAME])
            xfprintf(output, "    Baseboard Model: %s" NEWLINE, DmiStrings[BOARD_NAME]);
        if (DmiStrings[BOARD_VERSION])
            xfprintf(output, "    Baseboard Version: %s" NEWLINE, DmiStrings[BOARD_VERSION]);
        FreeSMBiosData(SMBiosBuf);
    }
 
    SYSTEM_INFO info;
    GetSystemInfo(&info);
    xfprintf(output, "    Number of Processors: %d" NEWLINE, info.dwNumberOfProcessors);
 
    HKEY hKey;
    LONG ret = RegOpenKeyExA(HKEY_LOCAL_MACHINE, "HARDWARE\\DESCRIPTION\\System\\CentralProcessor\\0",
                             0, KEY_READ, &hKey);
    if (ret == ERROR_SUCCESS)
    {
        DWORD dwType;
        count = sizeof(Buffer);
        ret = RegQueryValueExA(hKey, "Identifier", NULL, &dwType, (LPBYTE)Buffer, &count);
        if (ret == ERROR_SUCCESS && dwType == REG_SZ)
        {
            Buffer[count] = '\0';
            xfprintf(output, "    Processor Type: %s" NEWLINE, Buffer);
        }
        RegCloseKey(hKey);
    }
 
    ret = RegOpenKeyExA(HKEY_LOCAL_MACHINE, "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion", 0, KEY_READ, &hKey);
    if (ret == ERROR_SUCCESS)
    {
        char Version[50];
        ReadKey(hKey, "ProductName", Buffer, sizeof(Buffer));
        ReadKey(hKey, "CurrentVersion", Version, sizeof(Version));
        xfprintf(output, "    %s Version: %s" NEWLINE, Buffer, Version);
        ReadKey(hKey, "BuildLab", Buffer, sizeof(Buffer));
        xfprintf(output, "    BuildLab: %s" NEWLINE, Buffer);
        ReadKey(hKey, "CSDVersion", Buffer, sizeof(Buffer));
        if (Buffer[0])
            xfprintf(output, "    Service Pack: %s" NEWLINE, Buffer);
        ReadKey(hKey, "CurrentType", Buffer, sizeof(Buffer));
        xfprintf(output, "    Current Type: %s" NEWLINE, Buffer);
        ReadKey(hKey, "RegisteredOrganization", Buffer, sizeof(Buffer));
        xfprintf(output, "    Registered Organization: %s" NEWLINE, Buffer);
        ReadKey(hKey, "RegisteredOwner", Buffer, sizeof(Buffer));
        xfprintf(output, "    Registered Owner: %s" NEWLINE, Buffer);
 
        RegCloseKey(hKey);
    }
}

Referenced by PrintBugreport().

UpdateFromEvent()

bool UpdateFromEvent	(	DEBUG_EVENT &	evt,
		DumpData &	data
	)

Definition at line 56 of file drwtsn32.cpp.

{
    switch(evt.dwDebugEventCode)
    {
    case CREATE_PROCESS_DEBUG_EVENT:
    {
        data.ProcessPath.resize(MAX_PATH*2);
        DWORD len = GetModuleFileNameExW(evt.u.CreateProcessInfo.hProcess, NULL, &data.ProcessPath[0], data.ProcessPath.size());
        if (len)
        {
            data.ProcessPath.resize(len);
            std::string::size_type pos = data.ProcessPath.find_last_of(L"\\/");
            if (pos != std::string::npos)
                data.ProcessName = data.ProcessPath.substr(pos+1);
        }
        else
        {
            data.ProcessPath = L"??";
        }
        if (data.ProcessName.empty())
            data.ProcessName = data.ProcessPath;
 
        CloseHandle(evt.u.CreateProcessInfo.hFile);
        data.ProcessID = evt.dwProcessId;
        data.ProcessHandle = evt.u.CreateProcessInfo.hProcess;
        data.Threads[evt.dwThreadId] = ThreadData(evt.u.CreateProcessInfo.hThread);
    }
        break;
    case CREATE_THREAD_DEBUG_EVENT:
        data.Threads[evt.dwThreadId] = ThreadData(evt.u.CreateThread.hThread);
        break;
    case EXIT_THREAD_DEBUG_EVENT:
    {
        ThreadMap::iterator it = data.Threads.find(evt.dwThreadId);
        if (it != data.Threads.end())
        {
            data.Threads.erase(it);
        }
    }
        break;
    case LOAD_DLL_DEBUG_EVENT:
        CloseHandle(evt.u.LoadDll.hFile);
        for (size_t n = 0; n < data.Modules.size(); ++n)
        {
            if (data.Modules[n].BaseAddress == evt.u.LoadDll.lpBaseOfDll)
            {
                data.Modules[n].Unloaded = false;
                return true;
            }
        }
        data.Modules.push_back(ModuleData(evt.u.LoadDll.lpBaseOfDll));
        break;
    case UNLOAD_DLL_DEBUG_EVENT:
        for (size_t n = 0; n < data.Modules.size(); ++n)
        {
            if (data.Modules[n].BaseAddress == evt.u.UnloadDll.lpBaseOfDll)
                data.Modules[n].Unloaded = true;
        }
        break;
    case OUTPUT_DEBUG_STRING_EVENT: // ignore
        break;
    case EXCEPTION_DEBUG_EVENT:
        if (evt.u.Exception.dwFirstChance)
        {
            switch(evt.u.Exception.ExceptionRecord.ExceptionCode)
            {
            case EXCEPTION_BREAKPOINT:
                if (!data.FirstBPHit)
                {
                    data.FirstBPHit = true;
 
                    if (data.Event)
                    {
                        SetEvent(data.Event);
                        CloseHandle(data.Event);
                        data.Event = NULL;
                    }
                    return true;
                }
                break;
            case MS_VC_EXCEPTION_THREAD_NAME:
                /* Thread name */
                return true;
            case DBG_CONTROL_C:
            case DBG_CONTROL_BREAK:
                return true;
            }
        }
        data.ExceptionInfo = evt.u.Exception;
        data.ThreadID = evt.dwThreadId;
        return false;
    case EXIT_PROCESS_DEBUG_EVENT:
        //assert(FALSE);
        return false;
    case RIP_EVENT:
        //assert(FALSE);
        return false;
    default:
        assert(false);
    }
    return true;
}

Referenced by wWinMain().

xfprintf()

void xfprintf	(	FILE *	stream,
		const char *	fmt,
			...
	)

Definition at line 34 of file main.cpp.

{
    va_list ap;
 
    va_start(ap, fmt);
    vfprintf(stream, fmt, ap);
    vDbgPrintEx(-1, DPFLTR_ERROR_LEVEL, fmt, ap);
    va_end(ap);
}

Referenced by PrintBugreport(), PrintStackBacktrace(), PrintSystemInfo(), PrintThread(), and wWinMain().