How parallaxsw/opensta works
Project Type and Purpose
• Type: Native C++ static timing analysis engine with a TCL‐based CLI.
• Purpose: Read standard EDA file formats (Verilog, Liberty, SDC, SDF, SPEF, VCD/SAIF), build an internal netlist/timing graph, run delay calculations and path searches, and produce timing reports or Spice output.
• Key indicator: README describes “timing engine,” “TCL command interpreter,” input formats, and analysis features.
File Structure
• Top‐level build/CI: CMakeLists.txt, Dockerfiles, Jenkinsfiles.
• Core application: app/ (Main.cc, StaApp.i, StaMain.cc).
• Public API: include/sta/ *.hh, StaMain.hh, Sta.h.
• Modules by function:
– Verilog parser: verilog/
– Liberty reader: liberty/
– SDC constraints: sdc/
– SDF delay annotation: sdf/
– Parasitics (SPEF): parasitics/
– Power activities (VCD/SAIF): power/
– Delay calculators: dcalc/
– Graph utilities: graph/
– Network adapter: network/
– Search/path analysis: search/
– Spice export: spice/
– TCL extensions: tcl/
– Utilities: util/
• Examples, tests, docs live in examples/, test/, doc/.
README for Architecture Insights
• Uses a “network adapter” to integrate host netlist.
• Modular timing engine (“easily bolted on to other tools”).
• TCL layer for commands and scripting.
• External libraries: CUDD, Eigen, zlib, TCL, SWIG.
Main Components
a. External Inputs:
– Verilog netlist file
– Liberty library
– SDC constraints
– SDF delay annotation
– SPEF parasitics
– VCD/SAIF power activity
b. Parsers/Readers:
– verilog/ → internal netlist format
– liberty/ → timing model
– sdc/ → constraint graph
– sdf/ → annotated delays
– parasitics/ → RC parasitic data
– power/ → activity data
c. Core Data Structures:
– CircuitSim, Network, ConcreteNetwork, Parasitics, Corner, Path, TimingArc
– Stored in include/sta and util/ modules
d. Analysis Engines:
– DelayCalc variants (dcalc/)
– GraphTraversal (graph/)
– Search/Path enumeration (search/)
– Clock analysis, exception paths (sdc/)
– Spice export (spice/)
e. TCL Interpreter Layer:
– SWIG bindings (app/StaApp.i, *.tcl under tcl/)
– CLI commands under tcl/ and graph/*.tcl
f. Outputs:
– Timing reports (console, JSON)
– Annotated netlists (SDF, SPEF)
– Spice netlists (Spice, Xyce)
g. Build & CI:
– CMake, Dockerfiles, Jenkins pipelines
h. External Libraries:
– CUDD (BDD engine)
– Eigen (linear algebra)
– zlib (optional compression)
– TCL, SWIG, Flex/Bison
Relationships & Data Flows
• Parsers feed Core Data Structures
• Core Data Structures → Analysis Engines (delay, search)
• Analysis Engines → Outputs
• CLI (TCL interpreter) instantiates Engine, passes commands, loads inputs, triggers analyses, displays results
• Build/CI orchestrates compilation and testing
Architectural Patterns & Design Principles
• Modular, layered architecture (separate parser, core, analysis, CLI layers)
• Adapter pattern for “network adapter” to integrate external netlist
• Plugin‐style modules for each file format and analysis type
• Query‐based incremental updates (per README)
• SWIG bindings to expose C++ API into TCL
Essential Elements to Capture
• Module boundaries: e.g., verilog parser does not know about search modules.
• Data transformation flow: file → parse → internal graph → analysis → report.
• External dependencies (CUDD, Eigen, TCL) clearly.
• Build/CI context (Docker, Jenkins, CMake).