UDB VSCode Extension

A Visual Studio Code extension for working with UDB (Unified Database) schema files used in the RISC-V Unified Database project.

Features

Syntax Highlighting

Full syntax highlighting for UDB schema files, making it easier to read and navigate complex database definitions at a glance.

Autocomplete

Context-aware autocomplete suggestions as you type, helping you write valid UDB schemas faster and with fewer errors.

Schema Support

Dedicated support for the following UDB schema types:

• CSR schemas — author Control and Status Register definitions
• Instruction schemas — define and edit RISC-V instruction definitions
• Extension schemas — work with RISC-V extension definitions
• Config schemas — define architecture configurations
• Exception code schemas — define exception codes
• Instruction opcode schemas — define instruction opcodes
• Instruction variable type schemas — define instruction variable types
• Interrupt code schemas — define interrupt codes
• Manual schemas — define manual metadata
• Manual version schemas — define manual version metadata
• Non-ISA schemas — define non-ISA specifications
• Profile family schemas — define profile families
• Profile schemas — define RISC-V profiles
• Register file schemas — define register files

Cross-Referencing

Navigate across related schema definitions with cross-referencing support — jump to referenced definitions directly from within your editor.

Requirements

• Visual Studio Code v1.109.0 or higher
• Java installed and available on PATH (required to run the language server)
• UDB schema files from the RISC-V Unified Database project

Getting Started

1. Install the extension from the VS Code Marketplace
2. Ensure Java is installed (java -version to verify)
3. Open a folder containing your UDB schema files
4. Start editing — syntax highlighting, autocomplete, and cross-referencing will activate automatically on .udb files

Troubleshooting

If the language server doesn't start, check the Output panel (Ctrl+Shift+U / Cmd+Shift+U) and select UDB Language Server from the dropdown. If Java is not found, set the path explicitly in your VS Code settings:

"udb.javaPath": "/path/to/java"

Feedback & Contributions

This extension is developed and maintained by the Harvey Mudd Clinic Team. For bugs or feature requests, please open an issue on the project repository.