Xbox Debug Monitor
The Xbox Debug Monitor (XBDM) is a feature of Xbox Development Kits that provides remote debugging, file management, console discovery, and other services on TCP/UDP port 731. It is loaded by debug kernels at startup from
C:\xbdm.dll and its configuration is read from
E:\xbdm.ini. XBDM is distinct from KD and uses a different wire protocol.
- 1 Name Answering Protocol
- 2 Remote Debugging and Control Protocol
- 2.1 Status codes
- 2.2 Connection dedication
- 2.3 Security
- 2.4 Commands
- 2.4.1 adminpw (Set administrator password)
- 2.4.2 altaddr
- 2.4.3 authuser (Authenticate user)
- 2.4.4 boxid
- 2.4.5 break
- 2.4.6 bye (Close connection)
- 2.4.7 capcontrol/capctrl
- 2.4.8 continue
- 2.4.9 crashdump
- 2.4.10 d3dopcode
- 2.4.11 dbgname (Get/set debug name)
- 2.4.12 dbgoptions
- 2.4.13 debugger
- 2.4.14 debugmode
- 2.4.15 dedicate (Dedicate connection)
- 2.4.16 deftitle
- 2.4.17 delete (Delete file or directory)
- 2.4.18 dirlist (List files in directory)
- 2.4.19 dmversion (Get debug monitor version)
- 2.4.20 drivefreespace (Get free space on drive)
- 2.4.21 drivelist (List drive letters)
- 2.4.22 dvdblk (Read block from DVD)
- 2.4.23 dvdperf
- 2.4.24 fileeof
- 2.4.25 flash (Flash BIOS image)
- 2.4.26 fmtfat (Format FAT partition)
- 2.4.27 funccall
- 2.4.28 getcontext (Get thread context)
- 2.4.29 getd3dstate (Get Direct3D state)
- 2.4.30 getextcontext (Get extended thread context)
- 2.4.31 getfile (Download file)
- 2.4.32 getfileattributes (Get file attributes)
- 2.4.33 getgamma (Get gamma table)
- 2.4.34 getmem (Read memory)
- 2.4.35 getmem2 (Read memory)
- 2.4.36 getpalette
- 2.4.37 getpid
- 2.4.38 getsum (Generate memory checksums)
- 2.4.39 getsurf
- 2.4.40 getuserpriv (Get user's privilege level)
- 2.4.41 getutildrvinfo (Get utility drive information)
- 2.4.42 go
- 2.4.43 gpucount (Toggle GPU counters)
- 2.4.44 halt
- 2.4.45 irtsweep
- 2.4.46 isbreak
- 2.4.47 isdebugger
- 2.4.48 isstopped
- 2.4.49 kd (Enable/disable kernel debugger)
- 2.4.50 keyxchg (Perform key exchange)
- 2.4.51 lockmode
- 2.4.52 lop
- 2.4.53 magicboot (Boot into new title)
- 2.4.54 memtrack
- 2.4.55 mkdir (Create directory)
- 2.4.56 mmglobal
- 2.4.57 modlong
- 2.4.58 modsections
- 2.4.59 modules
- 2.4.60 nostopon
- 2.4.61 notify
- 2.4.62 notifyat
- 2.4.63 pbsnap
- 2.4.64 pclist (List performance counters)
- 2.4.65 pdbinfo
- 2.4.66 pssnap
- 2.4.67 querypc (Query performance counter)
- 2.4.68 reboot
- 2.4.69 rename (Rename file)
- 2.4.70 resume
- 2.4.71 screenshot (Take screenshot)
- 2.4.72 sendfile (Upload file)
- 2.4.73 servname
- 2.4.74 setconfig
- 2.4.75 setcontext (Set thread context)
- 2.4.76 setfileattributes (Set file attributes)
- 2.4.77 setsystime (Set system time)
- 2.4.78 setuserpriv (Set user's privilege level)
- 2.4.79 signcontent
- 2.4.80 stop
- 2.4.81 stopon
- 2.4.82 suspend
- 2.4.83 sysfileupd (Update system file)
- 2.4.84 systime (Get system time)
- 2.4.85 threadinfo (Get thread information)
- 2.4.86 threads (List threads)
- 2.4.87 title
- 2.4.88 user
- 2.4.89 userlist (List users)
- 2.4.90 vssnap
- 2.4.91 walkmem
- 2.4.92 writefile
- 2.4.93 xbeinfo
- 2.4.94 xtlinfo
- 3 See Also
- 4 External Links
Name Answering Protocol
An Xbox Development Kit (XDK) can be assigned a debug name that identifies it on the local network. XBDM provides the ability to resolve a debug name to an IP address (forward lookup), resolve an IP address to a debug name (reverse lookup), and discover all XDKs on the local network using a very simple UDP-based protocol.
A NAP packet contains 3 fields, the last of which is variable-length. The minimum length of a NAP packet is 2 bytes and the maximum is 257. Invalid packets are silently dropped by XBDM.
- This unsigned 8-bit field may contain the values 1 (lookup), 2 (reply), or 3 (wildcard).
- Name Length
- This unsigned 8-bit field specifies the length of the Name field and should be a value from 0 to 255. For Type 3 packets, this field should always be 0. For Type 1 and Type 2 packets, this field should never be 0.
- This variable-length field contains the ASCII-encoded debug name for Type 1 and Type 2 packets. The number of bytes in this field is given by the Length field. It should not contain any
To resolve a debug name to an IP address, send a Type 1 NAP packet containing the debug name to be resolved to UDP address 255.255.255.255:731. The XDK with that name will respond with a Type 2 NAP packet and its IP address can be retrieved from the UDP header. There is no way to prevent multiple XDKs being assigned the same debug name, so it's possible that the client may receive replies from multiple IP addresses.
To resolve an IP address to a debug name, send a Type 3 NAP packet with no name (length 0) to the IP address on UDP port 731. Assuming the target is actually an XDK, it will respond with a Type 2 NAP packet containing its name. This is very similar to the Console Discovery process (below), except that by sending the wildcard packet to a single IP address, only that XDK will respond.
To discover all XDKs on the local network, send a Type 3 NAP packet with no name (length 0) to the UDP address 255.255.255.255:731. Each XDK will respond with a Type 2 NAP packet containing its name. As with a forward lookup, the client may receive multiple replies with the same name, but different IP addresses.
Remote Debugging and Control Protocol
The Remote Debugging and Control Protocol (RDCP) is a text-based protocol transmitted over a TCP connection on port 731. RDCP resembles protocols like FTP and SMTP, making it possible to communicate with XBDM using just a Telnet client in many cases.
When a connection is established, XBDM sends
201- connected (or
200- connected in version 3944) followed by <CR><LF> (that is, a carriage return character followed by a line feed character). The RDCP client is then free to send a command followed by <CR><LF> or <CR><NUL>.
After executing a command, XBDM replies with a response line consisting of a three-digit status code and message of the form
999- message text<CR><LF>. Note that unlike similar protocols, the
- (dash) is always present in responses and messages cannot span multiple lines.
In responses, 2xx status codes indicate success and 4xx codes indicate failure. Most codes have a default message, but some commands leave the message field empty while others use the message field to hold whatever data was requested by the client or additional information about an error.
- 200- OK
- Standard response for successful execution of a command.
- 201- connected
- Initial response sent after a connection is established. The client does not need to send anything to solicit this response.
- 202- multiline response follows
- The response line is followed by one or more additional lines of data terminated by a line containing only a
.(period). The client must read all available lines before sending another command.
- 203- binary response follows
- The response line is followed by raw binary data, the length of which is indicated in some command-specific way. The client must read all available data before sending another command.
- 204- send binary data
- The command is expecting additional binary data from the client. After the client sends the required number of bytes, XBDM will send another response line with the final result of the command.
- 205- connection dedicated
- The connection has been moved to a dedicated handler thread (see #Connection dedication).
- 400- unexpected error
- An internal error occurred that could not be translated to a standard error code. The message is typically more descriptive, such as "out of memory" or "bad parameter".
- 401- max number of connections exceeded
- The connection could not be established because XBDM is already serving the maximum number of clients (4).
- 402- file not found
- An operation was attempted on a file that does not exist.
- 403- no such module
- An operation was attempted on a module that does not exist.
- 404- memory not mapped
- An operation was attempted on a region of memory that is not mapped in the page table.
- 405- no such thread
- An operation was attempted on a thread that does not exist.
- An attempt to set the system time with the
setsystimecommand failed. This status code is undocumented.
- 407- unknown command
- The command is not recognized.
- 408- not stopped
- The target thread is not stopped.
- 409- file must be copied
- A move operation was attempted on a file that can only be copied.
- 410- file already exists
- A file could not be created or moved because one already exists with the same name.
- 411- directory not empty
- A directory could not be deleted because it still contains files and/or directories.
- 412- filename is invalid
- The specified file contains invalid characters or is too long.
- 413- file cannot be created
- The file cannot be created for some unspecified reason.
- 414- access denied
- The file cannot be accessed at the connection's current privilege level (see #Security).
- 415- no room on device
- The target device has run out of storage space.
- 416- not debuggable
- The title is not debuggable.
- 417- type invalid
- The performance counter type is invalid.
- 418- data not available
- The performance counter data is not available.
- 420- box not locked
- The command can only be executed when security is enabled (see #Security).
- 421- key exchange required
- The client must perform a key exchange with the
keyxchgcommand (see #Security).
- 422- dedicated connection required
- The command can only be executed on a dedicated connection (see #Connection dedication).
Connection dedication is the process of moving a client connection from the global server thread to a threaded command handler thread with the
By default, commands sent to XBDM are processed on the global server thread. Built-in commands and custom command handlers registered with
DmRegisterCommandProcessor are run on this thread and may only execute kernel APIs. Commands that need to call CRT or XAPI functions must run in a threaded command handler, registered with
A client that has not dedicated its connection will receive a
422- dedicated connection required response if it tries to execute a threaded command on the global server thread. After dedicating itself to a threaded command handler, the client can no longer send built-in or non-threaded commands until it re-dedicates itself to the global server thread.
See also: XBDM commands by version
A command consists of a name and zero or more parameters separated by whitespace characters. The format of the parameters is defined by the command, but most commands use the form
key=value. Parameter values that contain whitespace characters must be surrounded by double quotes (e.g.
"some value" or
In the command descriptions below, the following data types are used:
|DWORD|| A 32-bit integer in hexadecimal format (e.g. |
|QWORD|| A 64-bit integer in hexadecimal format, but prefixed with 0q instead of 0x (e.g. |
|STRING||An ASCII-encoded string, optionally surrounded by double quotes.|
adminpw (Set administrator password)
Clear the administrator password.
Set the administrator password to the value of the
passwd parameter. Note that
passwd is a 64-bit integer instead of a string. The details of the conversion from a string password to a 64-bit integer are currently unknown.
authuser (Authenticate user)
bye (Close connection)
dbgname (Get/set debug name)
dedicate (Dedicate connection)
delete (Delete file or directory)
Deletes a file or directory.
To delete a directory, the optional
dir attribute must be present.
dirlist (List files in directory)
dmversion (Get debug monitor version)
drivefreespace (Get free space on drive)
drivelist (List drive letters)
Returns a string which contains the drive-letter for each accessible drive.
dvdblk (Read block from DVD)
flash (Flash BIOS image)
fmtfat (Format FAT partition)
getcontext (Get thread context)
getd3dstate (Get Direct3D state)
getextcontext (Get extended thread context)
getfile (Download file)
Retrieve the entire contents of the named file. The received data is prefixed with a 32 bit little endian value, which contains the number of bytes which have been read.
size bytes starting at
offset from the named file.
The received data is prefixed with a 32 bit little endian value, which contains the number of bytes which have been read.
getfileattributes (Get file attributes)
getgamma (Get gamma table)
getmem (Read memory)
getmem2 (Read memory)
getsum (Generate memory checksums)
Generates one or more checksums from memory.
The function will return
length divided by
blocksize 32-bit little endian checksums for the memory starting at virtual address
blocksize must be multiples of 8.
Picking bad values can lead to crashes.
Each checksum is equal to
ReverseBitOrder(CRC32(address + blockoffset, blocksize) XOR 0xFFFFFFFF) for the respective block.
getuserpriv (Get user's privilege level)
getutildrvinfo (Get utility drive information)
gpucount (Toggle GPU counters)
kd (Enable/disable kernel debugger)
keyxchg (Perform key exchange)
magicboot (Boot into new title)
Boots into another title, specified by the path to XBE in
If the optional
debug is provided, XBDM will remain loaded while the title is running.
mkdir (Create directory)
pclist (List performance counters)
querypc (Query performance counter)
rename (Rename file)
screenshot (Take screenshot)
sendfile (Upload file)
setcontext (Set thread context)
setfileattributes (Set file attributes)
setsystime (Set system time)
setuserpriv (Set user's privilege level)
sysfileupd (Update system file)
systime (Get system time)
threadinfo (Get thread information)
threads (List threads)
userlist (List users)
- Xbox Neighborhood – An XDK tool that utilizes the XBDM protocols