Difference between revisions of "ReactOS Remote Debugger"

From ReactOS Wiki
Jump to: navigation, search
(Using it)
Line 37: Line 37:
 
  -serial tcp::1235,server
 
  -serial tcp::1235,server
  
to your QEMU command line.  Use 'File|Connect TCPIP...' to connect.
+
to your QEMU command line.  Use 'File|Connect TCP/IP...' to connect.
  
 
==== With VMWARE ====
 
==== With VMWARE ====
  
 
Todo, not completely implemented.
 
Todo, not completely implemented.
 +
 +
Serial port configuration in VMWARE:
 +
 +
[[Image:Vmware-pipe-cfg.png]]
 +
 +
Use 'File|Connect Pipe...' to connect.
  
 
=== Breaking in ===
 
=== Breaking in ===

Revision as of 07:09, 20 August 2008

ReactOSDbg

Source code

svn://svn.reactos.org/reactos/trunk/tools/ReactOSDbg

Description

It's a debugging shell that can take protocol modules (currently only for talking to KDBG), .nostrip files from the ReactOS build, and aggregate information in a way that's a bit impractical in KDBG. It's a windows forms app (C#) with a number of window types, a simple poor man's dockability, and tabs.

It's got a local variables window, backtrace, debug interaction, threads and processes. It can display a lot of info, and will become more useful as features are fleshed out.

Setting it up

You need a full build with ROS_BUILDNOSTRIP=yes. Clean before building it the first time, as already built (and up to date) modules won't be rebuilt. Do it like this:

make ROS_BUILDNOSTRIP=yes bootcd

Now that you've got symbols, select your source directory and output directory in the 'File|Settings...' menu of ReactOSDbg. Set the source dir to the 'reactos' directory that contains your sources. Set the output dir to the output-i386 directory you build into.

Make sure your freeldr.ini boots reactos like this:

Options=/DEBUG /DEBUGPORT=COM1 /KDSERIAL /BAUDRATE=115200

Actually, you can use any baud rate you want as long as your cabling allows a relatively low error rate. Optionally add /BREAK to break in early.

Using it

With Real Hardware

Connect your null modem cable between com ports on your two computers, and use the 'File|Connect Serial...' menu option to connect.

With QEMU

Add

-serial tcp::1235,server

to your QEMU command line. Use 'File|Connect TCP/IP...' to connect.

With VMWARE

Todo, not completely implemented.

Serial port configuration in VMWARE:

Vmware-pipe-cfg.png

Use 'File|Connect Pipe...' to connect.

Breaking in

If all goes well, connect to a running reactos instance and crash it (or hit Tab+K) and you'll break in in the debugger. The ReactOSDbg will request a number of updates from KDBG to see where things are, examine the stack, etc. If you don't see this traffic, the most likely reason is that you've booted without /KDSERIAL, and KDBG input is coming from the keyboard. You really really have to set /KDSERIAL (and afaik put it after /DEBUGPORT) in your boot options, despite it not being default. It might become default at some point.

If you see garbage and you're on a serial port, the most likely reason is that you've got ReactOSDbg and ReactOS set to different baud rates. We don't support auto baud setting yet, although somebody might be able to implement it fairly easily. It could also be dangerous at early /BREAK.

If all goes well, reactos will break in, ReactOSDbg will poke around, and display a number of line in backtrace (addresses followed by source file and line number), and will populate the locals and threads+processes data grids.

You can check that your locals appear by putting an __asm__("int3"); in your code. You should see all locally scoped variables and their values in the locals window when ReactOS breaks in.

Unlike KDBG, ReactOSDbg uses dbghelp.dll (the wine version, that reads stabs) to read the local copy of the .nostrip files that are the byproduct of the ROS_BUILDNOSTRIP=yes build. Unlike the abbreviated rossym sections in the canoncal binaries (suitable only for line number information), these contain all the information that's normally used by GDB to examine values in a running process. Since it doesn't rely on KDBG to lookup debug info, we could run a fully stripped build and still get debug info on the host (that is; debug a release build in a sensible way), and eventually, it'll be switched to kd protocol when ReactOS supports it. After that, it could be used to debug real windows, when given appropriate pdb files and the redistributable dbghelp.dll.

Notes and troubles

The most common complaint is that the channel back to ReactOS doesn't respond. This is caused by omitting /KDSERIAL from your kernel command line. Please add /KDSERIAL after /DEBUGPORT=COMn .

KDBG, being a human interaction protocol, doesn't support retransmission. Luckily, ReactOSDbg is mostly stateless and responds to reports from KDBG as they become available. When in doubt, typing 'regs' and hitting return into the 'Raw Traffic' window (with the edit pane focused) should get the essential updates flowing. It'll have a better automatic mechanism for that at some point in the future.