Setting Upwards KDNET Network Kernel Debugging Automatically

  • Article
  • 7 minutes to read

Debugging Tools for Windows supports kernel debugging over a network. This topic describes how to set network debugging automatically using the kdnet.exe setup tool.

The computer that runs the debugger is called the host reckoner, and the figurer being debugged is called the target computer. The host figurer must exist running Windows 7 or later, and the target figurer must be running Windows 8 or later.

Determining the IP Address of the Host Computer

  1. Confirm that the target and host PCs are connected to a network hub or switch using an appropriate network cable.

  2. On the host figurer, open up a Command Prompt window and enter IPConfig to brandish the IP configuration.

  3. In the command output, locate the IPv4 address of the Ethernet adapter.

              ...  Ethernet adapter Ethernet: ...  IPv4 Address. . . . . . . . . . . : <YourHostIPAddress> ...

4.Brand a note of the IPv4 accost of the network adapter that you intend to use for debugging.

Setting Up the Host and Target Computers

Use the kdnet.exe utility to automatically configure the debugger settings on the target PC, past following these steps.

  1. Confirm that the Windows Debugging Tools are installed on the host organisation. For information on downloading and installing the debugger tools, see Download Debugging Tools for Windows.

  2. Locate the kdnet.exe and VerifiedNICList.xml files. By default, they are located hither.

                      C:\Program Files (x86)\Windows Kits\10\Debuggers\x64

    Note

    These directions assumes that both PCs are running a 64 flake version of Windows on both the target and host. If that is not the instance, the all-time approach is to run the same "bitness" of tools on the host that the target is running. For example, if the target is running 32-chip Windows, run a 32 version of the debugger on the host. For more information, see Choosing the 32-Scrap or 64-Bit Debugging Tools.

  3. On the host computer, re-create the two files to a network share or thumb bulldoze, so that they volition exist available on the target computer.

  4. On the target computer, create a C:\KDNET directory and copy the kdnet.exe and VerifiedNICList.xml files to that directory.

    Of import

    Before using kdnet.exe to change boot information yous may need to temporarily suspend Windows security features such every bit BitLocker and Secure Kick on the test PC. Re-enable these security features when testing is complete and appropriately manage the test PC, when the security features are disabled.

  5. On the target estimator, open a Command Prompt window every bit Administrator. Enter this command to verify that the target computer has a supported network adapter.

                      C:\KDNET>kdnet.exe Network debugging is supported on the post-obit NICs: busparams=1.0.0, Broadcom NetXtreme Gigabit Ethernet, Plugged in.   This Microsoft hypervisor supports using KDNET in guest VMs.

  6. As the output from kdnet.exe indicates that network adapter on the target is supported, we can keep.

  7. Type this command to set the IP address of the host system and generated a unique connection central. Use the IP address or the proper noun of the host organisation. Choice a unique port address for each target/host pair that you lot piece of work with, inside the recommended range of 50000-50039.

                      C:\>kdnet.exe <HostComputerIPAddress> <YourDebugPort>   Enabling network debugging on Intel(R) 82577LM Gigabit Network Connexion. Key=2steg4fzbj2sz.23418vzkd4ko3.1g34ou07z4pev.1sp3yo9yz874p

  8. Copy the returned fundamental into a notepad .txt file.

Connecting WinDbg to the target for kernel debugging

On the host computer, open WinDbg. On the File bill of fare, choose Kernel Debug. In the Kernel Debugging dialog box, open the Net tab. Paste in your port number and key that you lot saved to in the notepad .txt file earlier. Select OK.

Yous tin also offset a WinDbg session past opening a Command Prompt window and entering the following command, where <YourPort> is the port you selected above, and <YourKey> is the key that was returned past kdnet.exe above. Paste in the key in that you saved to in the notepad .txt file before.

              windbg -m -d net:port=<YourDebugPort>,key=<YourKey>

The optional -d parameter shown in the example, enables early intermission in. For more information, see WinDbg Command-Line Options.

If y'all are prompted about allowing WinDbg to access the port through the firewall, allow WinDbg to access the port for all three of the different network types.

windows security alert - windows firewall has blocked some features of this app .

At this signal the debugger will be waiting for the target to reconnect and text similar to the post-obit will exist displayed in the debugger command window.

              Microsoft (R) Windows Debugger Version 1.0.1908.30002 AMD64 Copyright (c) Microsoft Corporation. All rights reserved.  Using Net for debugging Opened WinSock ii.0 Waiting to reconnect...

Restarting the Target PC

One time the debugger is at the "Waiting to reconnect..." phase, reboot the target computer. One mode to do restart the PC, is to apply this control from an administrator's command prompt.

              shutdown -r -t 0

After the target PC restarts, the debugger should connect automatically.

Troubleshooting Tips

Debugging application must be allowed through firewall

The debugger must take access through the firewall. Apply Control Panel to allow admission through the firewall.

  1. Open Control Panel > Arrangement and Security and select Allow an app through Windows Firewall.

  2. In the list of applications, locate Windows GUI Symbolic Debugger and Windows Kernel Debugger.

  3. Utilize the bank check boxes to let those ii applications all three of the different network types through the firewall.

  4. Whorl down and select OK, to salvage the firewall changes. Restart the debugger.

    windows control panel firewall config showing Windows GUI Symbolic Debugger and Windows Kernel Debugger with all three network types enabled.

Use Ping to test connectivity

If the debugger times out and does non connect, use the ping command on the target PC to verify connectivity.

                              C:\>Ping <HostComputerIPAddress>

Choosing a Port for Network Debugging

If the debugger times out and does not connect, information technology could be considering the default port number of 50000 is already in use or it is blocked.

You tin choose any port number from 49152 through 65535. The recommended range is between 50000 and 50039. The port that you choose will exist opened for exclusive access by the debugger running on the host figurer.

Notation  The range of port numbers that can be used for network debugging might be limited by your visitor'due south network policy. To decide whether your company's policy limits the range of ports that tin can be used for network debugging, check with your network administrators.

Supported Network Adapters

If "Network debugging is non supported on any of the NICs in this machine" is displayed when you run kdnet.exe, information technology means that the network adapter is non supported.

The host computer can utilize any network adapter, merely the target estimator must utilise a network adapter that is supported by Debugging Tools for Windows. For a listing of supported network adapters, see Supported Ethernet NICs for Network Kernel Debugging in Windows 10 and Supported Ethernet NICs for Network Kernel Debugging in Windows 8.1.

Enable additional debugging types

Begining with Windows 10 October 2020 Update (20H2), the following options are supported to enable iv types of debugging.

b - enables bootmgr debugging. For more information see BCDEdit /bootdebug.

w - enables winload debugging. For more than data see BCDEdit /bootdebug.

h - enables hypervisor debugging. For more information meet BCDEdit /hypervisorsettings.

k - enables kernel debugging. For more data see Getting Started with WinDbg (Kernel-Mode).

Any combination of debug types may exist specified.

If no debug types are specified and so kernel debugging volition exist enabled.

If both hypervisor and kernel debug are enabled the hypervisor port will be set to the value port+i.

Example usage

Use the - bkw choice to enable bootmgr, kernel and winload debugging.

              C:\>kdnet.exe <HostComputerIPAddress> <YourDebugPort> -bkw  Enabling network debugging on Intel(R) 82577LM Gigabit Network Connectedness. Primal=2steg4fzbj2sz.23418vzkd4ko3.1g34ou07z4pev.1sp3yo9yz874p

Summary of debugging blazon options

KNDET Option Description Equivalent fix command
b enables bootmgr debugging bcdedit /bootdebug {bootmgr} on
h enables hypervisor debugging bcdedit /set hypervisordebug on
k enables kernel debugging bcdedit /debug on
w enables winload debugging bcdedit /bootdebug on

Specify bus parameters

If kdnet is not able to automatically determine the bus parameters for your transport, specify them on the command line with /busparams option using this syntax.

kdnet.exe /busparams [b.d.f] [host] [port] [-[b][h][k][w]]

[b.d.f] specifies the bus parameters of the device to configure.

Utilise Device Director on the target estimator to determine the PCI motorbus, device, and office numbers for the adapter y'all want to utilize for debugging. For bus parameters, enter b.d.f where b, d, and f are the motorcoach number, device number, and function number of the adapter. These values are displayed in Device Manager under Location on the Full general tab.

For example:

              C:\>kdnet.exe /busparams 0.29.seven <HostComputerIPAddress> <YourDebugPort> -bkw

Supported Ethernet NICs for Network Kernel Debugging in Windows 10

Supported Ethernet NICs for Network Kernel Debugging in Windows 8.1

Setting Up KDNET Network Kernel Debugging Manually

Getting Started with WinDbg (Kernel-Mode)

Debug Universal Drivers - Footstep past Step Lab (Repeat Kernel-Way)