ysyx-sdb-tui README

The ysyx-sdb-tui is a extension for NEMU or NPC SDB debugging tool. It can make the SDB support TUI mode in Visual Studio Code.

ysyx-sdb-tui

It can highlight the source code and disassembly code.

Dependencies

To use this extension, you need to add interface to NEMU or NPC. The source code and guide is in another repository.

Install this extension from the marketplace. Search for ysyx-sdb-tui.
Type Ctrl+Shift+P to open the command palette.
- Type ysyx sdb tui Enable and press Enter to enable the extension.
- Type ysyx sdb tui Disable and press Enter to disable the extension.
Run you NEMU or NPC program in the VSCode terminal in SDB debug mode. To enable TUI mode for NEMU or NPC, please refer to this repository.

After you enable the extension, it will open a socket server in the background. You can send the following commands to the server for control.

init [disas|gdb] file-path: set the disassembly file path and elf file path. Note that the elf file shall contain the debug information, you can add -g or -ggdb option when you compile the program.
- file-path: the absolute path of the file.
hl [disas|src|all] addr: highlight the disassembly code or source code based on the address.
- addr: the address of the pc register.
- all: concurrently execute the hl disas addr and hl src addr commands. Recommended! Performance is better.

The extension use the socket.io-server to communicate with other programs. You can use the socket.io-client to send the commands.

You can refer to the following links for more information:

You can set the socket server port in the settings.json file, default is 49159.

{
    "ysyxSdbTUI.serverPort": 49159
}

If you modify the port, you should restart the extension and modify the client port in the NEMU or NPC.

If you have any problems, please let me know.

The initial release of ysyx-sdb-tui.

The first release of ysyx-sdb-tui. Maybe it's not perfect, but it's a start.

Add icon and description.

Optimize the performance.

You should install the socket.io package in your project.

npm install socket.io
npm install @types/socket.io

TODO ...