📖 Architectural & Engineering Overview

Surelog is an industrial-strength SystemVerilog 2017 IEEE standard parser and elaborator hosted under the CHIPS Alliance. Led by Alain Dargelas, Surelog addresses one of the hardest challenges in open-source EDA: parsing the vast and intricate IEEE 1800-2017 grammar. Surelog produces UHDM (Universal Hardware Data Model), a standardized, binary-serializable abstract syntax tree that allows tools like Yosys, Verilator, and custom linters to process modern SystemVerilog constructs without writing dedicated parsers.

Role in the Hardware Ecosystem: SystemVerilog Front-End Elaboration & AST Generation. Whether deployed in academic research labs or continuous integration pipelines at silicon startups, Surelog provides a dependable, license-free pillar of the open-source electronics movement.

⚡ Key Capabilities & Features

  • ✔ Complete IEEE 1800-2017 SystemVerilog grammar support (packages, interfaces, structs, typedefs)
  • ✔ Robust preprocessor with support for complex macro expansions and file includes
  • ✔ Generates VPI-compliant UHDM data models for standardized downstream tool consumption
  • ✔ Integrates with Yosys via the yosys-uhdm plugin, unlocking full SystemVerilog synthesis
  • ✔ Multi-threaded parsing engine for rapid elaboration of massive SoC codebases
  • ✔ Comprehensive error reporting with source code context and lint diagnostics

💻 Practical Workflow Example: Elaborating SystemVerilog Design with Surelog

# Parse and elaborate a modern SystemVerilog module
surelog -parse -sverilog -d ast top_pkg.sv interface.sv dut.sv

# Generate UHDM binary for Yosys synthesis
surelog -parse -sverilog -nobuiltin -write_uhdm dut.sv

# Inspect elaborated UHDM model in terminal
uhdm-dump dut.uhdm

⚖️ Engineering Evaluation: Strengths & Limitations

✔ Key Advantages

  • + The most complete open-source SystemVerilog-2017 parser available today
  • + Backed by CHIPS Alliance (Google, Antmicro, Western Digital, SiFive)
  • + Decouples language parsing from downstream synthesis and verification tools

✖ Engineering Trade-offs

  • − Complex build dependencies (ANTLR4, Cap'n Proto, UHDM submodules)
  • − Focuses on parsing and elaboration; must be paired with downstream tools for simulation or synthesis