Introdução ao WinDbg (modo de usuário)

Este guia mostra como usar o WinDbg para depurar aplicativos de modo de usuário. Você pratica habilidades essenciais de depuração anexando-se a um processo em execução, definindo pontos de interrupção e diagnosticando falhas de aplicativos.

Neste artigo:

Anexe o WinDbg ao Bloco de Notas e explore a depuração básica
Depurar seu próprio aplicativo e analisar uma falha
Domine os comandos essenciais de depuração

O que você aprende

Anexar o WinDbg a um processo em execução
Configurar ficheiros de símbolos para uma saída de depuração legível
Definir pontos de interrupção e controlar a execução do programa
Analise falhas de aplicativos
Navegar por fluxos de execução e pilhas de chamadas

Pré-requisitos

WinDbg instalado no seu computador. Para obter instruções de instalação, consulte Baixar e instalar o depurador WinDbg do Windows.
Familiaridade básica com interfaces de linha de comando
(Opcional) Uma aplicação compilada com símbolos de depuração para o segundo exercício.

Tempo estimado para conclusão: 30 minutos

Abra o bloco de notas e anexe o WinDbg

Vá para o diretório de instalação e abra WinDbg.exe.
No menu Arquivo, selecione Iniciarexecutável . Na caixa de diálogo Iniciar executável , vá para a pasta que contém notepad.exe. (O arquivo notepad.exe geralmente está em C:\Windows\System32.) Em Nome do arquivo, digite notepad.exe. Selecione Abrir.
Configure arquivos de símbolos para que o WinDbg possa exibir nomes legíveis de funções e variáveis.

Na linha de comando perto da parte inferior da janela do WinDbg, digite este comando:

.sympath srv*

O resultado é semelhante ao seguinte exemplo:
```
Symbol search path is: srv*
Expanded Symbol search path is: cache*;SRV
```
O que são símbolos? Os arquivos de símbolo (PDB) contêm informações sobre módulos de código, como nomes de funções e nomes de variáveis. Sem símbolos, você vê apenas endereços de memória.

Em seguida, digite este comando:

.recarregar

O comando .reload diz ao WinDbg para fazer sua pesquisa inicial para localizar e carregar arquivos de símbolo.
Para ver os símbolos do módulo notepad.exe , digite este comando:

x bloco de notas!*

Observação

Se nenhuma saída aparecer, digite .reload /f para tentar forçar o carregamento do símbolo. Use !sym noisy para exibir informações adicionais de carregamento de símbolos.

Para ver símbolos no módulo notepad.exe que contêm main, use o comando examine symbols para listar módulos que correspondem à máscara:

x notepad!wWin*

O resultado é semelhante ao seguinte exemplo:
```
00007ff6`6e76b0a0 notepad!wWinMain (wWinMain)
00007ff6`6e783db0 notepad!wWinMainCRTStartup (wWinMainCRTStartup)
```
Para colocar um ponto de interrupção em notepad!wWinMain, digite este comando:

bu bloco de notas!wWinMain

Para verificar se você definiu seu ponto de interrupção, digite este comando:

BL

O resultado é semelhante ao seguinte exemplo:
```
0 e Disable Clear  00007ff6`6e76b0a0     0001 (0001)  0:**** notepad!wWinMain
```

Para iniciar o processo do Bloco de Notas, digite este comando:

O bloco de notas é executado até chegar à função WinMain e, em seguida, invade o depurador.

Breakpoint 0 hit
notepad!wWinMain:
00007ff6`6e76b0a0 488bc4          mov     rax,rsp

Para ver uma lista de módulos de código que estão atualmente carregados no processo do Bloco de Notas, digite este comando:

O resultado é semelhante ao seguinte exemplo:

0:000> lm
start             end                 module name
00007ff6`6e760000 00007ff6`6e798000   notepad    (pdb symbols)          C:\ProgramData\Dbg\sym\notepad.pdb\BC04D9A431EDE299D4625AD6201C8A4A1\notepad.pdb
00007ff8`066a0000 00007ff8`067ab000   gdi32full   (deferred)             
00007ff8`067b0000 00007ff8`068b0000   ucrtbase   (deferred)             
00007ff8`06a10000 00007ff8`06aad000   msvcp_win   (deferred)             
00007ff8`06ab0000 00007ff8`06ad2000   win32u     (deferred)             
00007ff8`06b40000 00007ff8`06e08000   KERNELBASE   (deferred)             
00007ff8`07220000 00007ff8`072dd000   KERNEL32   (deferred)             
00007ff8`07420000 00007ff8`07775000   combase    (deferred)             
00007ff8`07820000 00007ff8`079c0000   USER32     (deferred)             
00007ff8`079c0000 00007ff8`079f0000   IMM32      (deferred)             
00007ff8`07c00000 00007ff8`07c2a000   GDI32      (deferred)             
00007ff8`08480000 00007ff8`085ab000   RPCRT4     (deferred)             
00007ff8`085b0000 00007ff8`0864e000   msvcrt     (deferred)             
00007ff8`08c40000 00007ff8`08cee000   shcore     (deferred)             
00007ff8`08db0000 00007ff8`08fa5000   ntdll      (pdb symbols)          C:\ProgramData\Dbg\sym\ntdll.pdb\53F12BFE149A2F50205C8D5D66290B481\ntdll.pdb
00007fff`f8580000 00007fff`f881a000   COMCTL32   (deferred)

Para ver um rastreamento de pilha, digite este comando:

O resultado é semelhante ao seguinte exemplo:

0:000> k
00 000000c8`2647f708 00007ff6`6e783d36     notepad!wWinMain
01 000000c8`2647f710 00007ff8`07237034     notepad!__scrt_common_main_seh+0x106
02 000000c8`2647f750 00007ff8`08e02651     KERNEL32!BaseThreadInitThunk+0x14
03 000000c8`2647f780 00000000`00000000     ntdll!RtlUserThreadStart+0x21

Para iniciar o Bloco de Notas novamente, digite este comando:

g

A seguir: Você interromperá a execução e explorará os módulos carregados.
Para entrar no Bloco de Notas, no menu Ficheiro, selecione Interromper.
Para definir e verificar um ponto de interrupção em ZwWriteFile, insira estes comandos:

bu ntdll! ZwWriteFile

BL
Para iniciar o Bloco de Notas novamente, digite g. Na janela do Bloco de Notas, insira algum texto. No menu Arquivo, selecione Salvar. O código em execução falha quando se trata de ZwCreateFile. Digite o comando k para ver o stack trace.

Na janela WinDbg, à esquerda da linha de comando, os números do processador e do thread são mostrados. Neste exemplo, o número atual do processador é 0 e o número do thread atual é 11 (0:011>). A janela exibe o rastreamento de pilha para o thread 11 em execução no processador 0.

Para ver uma lista de todos os threads no processo do Bloco de Notas, digite este comando (o til "~"):

O resultado é semelhante ao seguinte exemplo:

0:011> ~
   0  Id: 5500.34d8 Suspend: 1 Teb: 000000c8`262c4000 Unfrozen
   1  Id: 5500.3960 Suspend: 1 Teb: 000000c8`262c6000 Unfrozen
    2  Id: 5500.5d68 Suspend: 1 Teb: 000000c8`262c8000 Unfrozen
    3  Id: 5500.4c90 Suspend: 1 Teb: 000000c8`262ca000 Unfrozen
    4  Id: 5500.4ac4 Suspend: 1 Teb: 000000c8`262cc000 Unfrozen
    5  Id: 5500.293c Suspend: 1 Teb: 000000c8`262ce000 Unfrozen
    6  Id: 5500.53a0 Suspend: 1 Teb: 000000c8`262d0000 Unfrozen
    7  Id: 5500.3ca4 Suspend: 1 Teb: 000000c8`262d4000 Unfrozen
    8  Id: 5500.808 Suspend: 1 Teb: 000000c8`262da000 Unfrozen
   10  Id: 5500.3940 Suspend: 1 Teb: 000000c8`262dc000 Unfrozen
 . 11  Id: 5500.28b0 Suspend: 1 Teb: 000000c8`262de000 Unfrozen
   12  Id: 5500.12bc Suspend: 1 Teb: 000000c8`262e0000 Unfrozen
   13  Id: 5500.4c34 Suspend: 1 Teb: 000000c8`262e2000 Unfrozen

Neste exemplo, 14 threads têm índices de 0 a 13.

Para examinar o rastreamento da pilha do thread 0, introduza os seguintes comandos:

~0s

O resultado é semelhante ao seguinte exemplo:

0:011> ~0s
0:011> ~0s
win32u!NtUserGetProp+0x14:
00007ff8`06ab1204 c3              ret
0:000> k
 # Child-SP          RetAddr               Call Site
00 000000c8`2647bd08 00007ff8`07829fe1     win32u!NtUserGetProp+0x14
01 000000c8`2647bd10 00007fff`f86099be     USER32!GetPropW+0xd1
02 000000c8`2647bd40 00007ff8`07d12f4d     COMCTL32!DefSubclassProc+0x4e
03 000000c8`2647bd90 00007fff`f8609aba     SHELL32!CAutoComplete::_EditWndProc+0xb1
04 000000c8`2647bde0 00007fff`f86098b7     COMCTL32!CallNextSubclassProc+0x9a
05 000000c8`2647be60 00007ff8`0782e858     COMCTL32!MasterSubclassProc+0xa7
06 000000c8`2647bf00 00007ff8`0782de1b     USER32!UserCallWinProcCheckWow+0x2f8
07 000000c8`2647c090 00007ff8`0782d68a     USER32!SendMessageWorker+0x70b
08 000000c8`2647c130 00007ff8`07afa4db     USER32!SendMessageW+0xda

Para terminar a depuração e desprender-se do processo do Bloco de Notas, digite este comando:

QD

Abra seu próprio aplicativo e anexe o WinDbg

Por exemplo, suponha que você escreveu e criou este pequeno aplicativo de console:

...
void MyFunction(long p1, long p2, long p3)
{
    long x = p1 + p2 + p3;
    long y = 0;
    y = x / p2;
}

void main ()
{
    long a = 2;
    long b = 0;
    MyFunction(a, b, 5);
}

Para este exercício, suponha que o aplicativo criado (MyApp.exe) e o arquivo de símbolo (MyApp.pdb) estão em C:\MyApp\x64\Debug. Suponha também que o código-fonte do aplicativo esteja em C:\MyApp\MyApp and that the target machine compiled MyApp.exe.

Abra o WinDbg.
No menu Arquivo, selecione Iniciarexecutável . Na caixa de diálogo Iniciar executável , vá para C:\MyApp\x64\Debug. Para Nome do ficheiro, introduza MyApp.exe. Selecione Abrir.
Insira estes comandos:

.symfix

.sympath+ C:\MyApp\x64\Debug

Esses comandos informam ao WinDbg onde encontrar símbolos e código-fonte para seu aplicativo. Nesse caso, você não precisa definir o local do código-fonte usando .srcpath porque os símbolos têm caminhos totalmente qualificados para os arquivos de origem.
Insira estes comandos:

.recarregar

bu MyApp!main

g

Seu aplicativo invade o depurador quando atinge sua main função.

WinDbg exibe seu código-fonte e a janela de comando.

No menu Depurar, selecione Entrar (ou selecione F11). Continue a caminhar até entrar em MyFunction. Quando você entra na linha y = x / p2, seu aplicativo falha e invade o depurador.

O resultado é semelhante ao seguinte exemplo:

(1450.1424): Integer divide-by-zero - code c0000094 (first chance)
First chance exceptions are reported before any exception handling.
This exception may be expected and handled.
MyApp!MyFunction+0x44:
00007ff6`3be11064 f77c2428    idiv  eax,dword ptr [rsp+28h] ss:00000063`2036f808=00000000

Digite este comando:

!analisar -v

WinDbg exibe uma análise do problema (neste caso, divisão por 0).

FAULTING_IP:
MyApp!MyFunction+44 [c:\myapp\myapp\myapp.cpp @ 7]
00007ff6`3be11064 f77c2428        idiv    eax,dword ptr [rsp+28h]

EXCEPTION_RECORD:  ffffffffffffffff -- (.exr 0xffffffffffffffff)
ExceptionAddress: 00007ff63be11064 (MyApp!MyFunction+0x0000000000000044)
   ExceptionCode: c0000094 (Integer divide-by-zero)
  ExceptionFlags: 00000000
NumberParameters: 0
...
STACK_TEXT:  
00000063`2036f7e0 00007ff6`3be110b8 : ... : MyApp!MyFunction+0x44
00000063`2036f800 00007ff6`3be1141d : ... : MyApp!main+0x38
00000063`2036f840 00007ff6`3be1154e : ... : MyApp!__tmainCRTStartup+0x19d
00000063`2036f8b0 00007ffc`b1cf16ad : ... : MyApp!mainCRTStartup+0xe
00000063`2036f8e0 00007ffc`b1fc4629 : ... : KERNEL32!BaseThreadInitThunk+0xd
00000063`2036f910 00000000`00000000 : ... : ntdll!RtlUserThreadStart+0x1d

STACK_COMMAND: dt ntdll!LdrpLastDllInitializer BaseDllName ;dt ntdll!LdrpFailureData ;.cxr 0x0 ;kb

FOLLOWUP_IP:
MyApp!MyFunction+44 [c:\myapp\myapp\myapp.cpp @ 7]
00007ff6`3be11064 f77c2428        idiv    eax,dword ptr [rsp+28h]

FAULTING_SOURCE_LINE:  c:\myapp\myapp\myapp.cpp

FAULTING_SOURCE_FILE:  c:\myapp\myapp\myapp.cpp

FAULTING_SOURCE_LINE_NUMBER:  7

FAULTING_SOURCE_CODE:  
     3: void MyFunction(long p1, long p2, long p3)
     4: {
     5:     long x = p1 + p2 + p3;
     6:     long y = 0;
>    7:  y = x / p2;
     8: }
     9:
    10: void main ()
    11: {
    12:     long a = 2;
...

Próximos passos

Depois de depurar um aplicativo do sistema e seu próprio código, você estará pronto para explorar cenários de depuração mais avançados:

Introdução ao WinDbg (modo do kernel) - Depurar o kernel e os drivers do Windows
Operação do depurador - Saiba mais sobre os conceitos de operação do depurador
Técnicas de depuração - Explore métodos avançados de depuração