# aesc-silicon/gdscheck architecture

> Architecture diagram of the GitHub repository aesc-silicon/gdscheck, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aesc-silicon/gdscheck
- Repository: https://github.com/aesc-silicon/gdscheck

## Overview

gdscheck is a Rust DRC engine that reads GDSII layouts, applies PDK-selected rule decks or suites, and emits violations and optional KLayout-compatible reports. The main workflow is documented in the README; sampled source and the SOURCE INDEX support the core module relationships. The rule families and geometry engine are substantial, but their internal call graph is only partly shown, so those relationships are summarized rather than expanded into unsupported detail.

Main entry points: [`src/checks/mod.rs`](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/mod.rs) (Rule Dispatch), [`src/lib.rs`](https://github.com/aesc-silicon/gdscheck/blob/main/src/lib.rs) (DRC Workflow), [`src/connectivity.rs`](https://github.com/aesc-silicon/gdscheck/blob/main/src/connectivity.rs) (Net Extraction), [`src/merge.rs`](https://github.com/aesc-silicon/gdscheck/blob/main/src/merge.rs) (Geometry Merge)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_input["Input and CLI"]
  node_cli["CLI Commands<br/>[main.rs]"]
  node_drc["DRC Workflow<br/>[lib.rs]"]
  node_flatten["Hierarchy Flattening<br/>[flatten.rs]"]
end

subgraph group_pdk["PDK and Rules"]
  node_pdkconfig["PDK Configuration<br/>[pdk.rs]"]
  node_expressions["Virtual Layers<br/>[expr.rs]"]
  node_ruleparams["Rule Parameters<br/>[params.rs]"]
end

subgraph group_engine["DRC Engine"]
  node_dispatch["Rule Dispatch<br/>[mod.rs]"]
  node_space["Spacing Checks<br/>[mod.rs]"]
  node_width["Width Checks<br/>[mod.rs]"]
  node_density["Density Checks<br/>[mod.rs]"]
  node_shapechecks["Shape Checks<br/>[mod.rs]"]
  node_residual["Residual Checks<br/>[mod.rs]"]
  node_edgechecks["Edge Distance<br/>[edge_distance.rs]"]
  node_connectivity["Net Extraction<br/>[connectivity.rs]"]
end

subgraph group_geometry["Geometry Core"]
  node_layout["Flat Layout<br/>[layout.rs]"]
  node_geometrylib["Measurements<br/>[geom.rs]"]
  node_merge["Geometry Merge<br/>[merge.rs]"]
  node_memory["Memory Support<br/>[memory.rs]"]
end

subgraph group_output["Results"]
  node_violations["Violation Records<br/>[violation.rs]"]
  node_report["Report Writer<br/>[report.rs]"]
end

node_user(("Engineer"))
node_gds["GDSII Layout"]
node_reportfile["LYRDB Report"]

node_user -->|"runs commands"| node_cli
node_cli -->|"starts run"| node_drc
node_gds -->|"provides layout"| node_drc
node_drc -->|"flattens hierarchy"| node_flatten
node_flatten -->|"produces geometry"| node_layout
node_drc -->|"loads PDK"| node_pdkconfig
node_pdkconfig -->|"lowers layers"| node_expressions
node_drc -->|"runs rules"| node_dispatch
node_dispatch -->|"dispatches checks"| node_space
node_dispatch -->|"dispatches checks"| node_width
node_dispatch -->|"dispatches checks"| node_density
node_dispatch -->|"dispatches checks"| node_shapechecks
node_dispatch -->|"dispatches checks"| node_residual
node_dispatch -->|"dispatches checks"| node_edgechecks
node_dispatch -->|"reads parameters"| node_ruleparams
node_dispatch -->|"checks layers"| node_layout
node_space -->|"uses net data"| node_connectivity
node_connectivity -->|"uses geometry"| node_merge
node_connectivity -->|"reads shapes"| node_layout
node_connectivity -->|"uses memory"| node_memory
node_space -->|"uses merged shapes"| node_merge
node_density -->|"uses merged shapes"| node_merge
node_width -->|"uses merged shapes"| node_merge
node_drc -->|"collects findings"| node_violations
node_dispatch -->|"returns findings"| node_violations
node_drc -->|"writes results"| node_report
node_report -->|"serializes report"| node_reportfile

click node_cli "https://github.com/aesc-silicon/gdscheck/blob/main/src/main.rs"
click node_drc "https://github.com/aesc-silicon/gdscheck/blob/main/src/lib.rs"
click node_flatten "https://github.com/aesc-silicon/gdscheck/blob/main/src/flatten.rs"
click node_pdkconfig "https://github.com/aesc-silicon/gdscheck/blob/main/src/pdk.rs"
click node_expressions "https://github.com/aesc-silicon/gdscheck/blob/main/src/expr.rs"
click node_ruleparams "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/params.rs"
click node_dispatch "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/mod.rs"
click node_space "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/space/mod.rs"
click node_width "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/width/mod.rs"
click node_density "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/density/mod.rs"
click node_shapechecks "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/shape/mod.rs"
click node_residual "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/residual/mod.rs"
click node_edgechecks "https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/edge_distance.rs"
click node_connectivity "https://github.com/aesc-silicon/gdscheck/blob/main/src/connectivity.rs"
click node_layout "https://github.com/aesc-silicon/gdscheck/blob/main/src/layout.rs"
click node_geometrylib "https://github.com/aesc-silicon/gdscheck/blob/main/src/geom.rs"
click node_merge "https://github.com/aesc-silicon/gdscheck/blob/main/src/merge.rs"
click node_memory "https://github.com/aesc-silicon/gdscheck/blob/main/src/memory.rs"
click node_violations "https://github.com/aesc-silicon/gdscheck/blob/main/src/violation.rs"
click node_report "https://github.com/aesc-silicon/gdscheck/blob/main/src/report.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_drc,node_flatten toneBlue
class node_pdkconfig,node_expressions,node_ruleparams toneAmber
class node_dispatch,node_space,node_width,node_density,node_shapechecks,node_residual,node_edgechecks,node_connectivity toneMint
class node_layout,node_geometrylib,node_merge,node_memory toneRose
class node_violations,node_report,node_user,node_gds,node_reportfile toneIndigo
```

## Components

### Input and CLI

- [CLI Commands](https://github.com/aesc-silicon/gdscheck/blob/main/src/main.rs): `src/main.rs`
- [DRC Workflow](https://github.com/aesc-silicon/gdscheck/blob/main/src/lib.rs): `src/lib.rs`
- [Hierarchy Flattening](https://github.com/aesc-silicon/gdscheck/blob/main/src/flatten.rs): `src/flatten.rs`

### PDK and Rules

- [PDK Configuration](https://github.com/aesc-silicon/gdscheck/blob/main/src/pdk.rs): `src/pdk.rs`
- [Virtual Layers](https://github.com/aesc-silicon/gdscheck/blob/main/src/expr.rs): `src/expr.rs`
- [Rule Parameters](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/params.rs): `src/checks/params.rs`

### DRC Engine

- [Rule Dispatch](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/mod.rs): `src/checks/mod.rs`
- [Spacing Checks](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/space/mod.rs): `src/checks/space/mod.rs`
- [Width Checks](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/width/mod.rs): `src/checks/width/mod.rs`
- [Density Checks](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/density/mod.rs): `src/checks/density/mod.rs`
- [Shape Checks](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/shape/mod.rs): `src/checks/shape/mod.rs`
- [Residual Checks](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/residual/mod.rs): `src/checks/residual/mod.rs`
- [Edge Distance](https://github.com/aesc-silicon/gdscheck/blob/main/src/checks/edge_distance.rs): `src/checks/edge_distance.rs`
- [Net Extraction](https://github.com/aesc-silicon/gdscheck/blob/main/src/connectivity.rs): `src/connectivity.rs`

### Geometry Core

- [Flat Layout](https://github.com/aesc-silicon/gdscheck/blob/main/src/layout.rs): `src/layout.rs`
- [Measurements](https://github.com/aesc-silicon/gdscheck/blob/main/src/geom.rs): `src/geom.rs`
- [Geometry Merge](https://github.com/aesc-silicon/gdscheck/blob/main/src/merge.rs): `src/merge.rs`
- [Memory Support](https://github.com/aesc-silicon/gdscheck/blob/main/src/memory.rs): `src/memory.rs`

### Results

- [Violation Records](https://github.com/aesc-silicon/gdscheck/blob/main/src/violation.rs): `src/violation.rs`
- [Report Writer](https://github.com/aesc-silicon/gdscheck/blob/main/src/report.rs): `src/report.rs`

### Other components

- **Engineer**
- **GDSII Layout**
- **LYRDB Report**

## Connections

- Engineer → CLI Commands: runs commands (evidence: `README.md`)
- CLI Commands → DRC Workflow: starts run (evidence: `src/main.rs`)
- GDSII Layout → DRC Workflow: provides layout (evidence: `README.md`)
- DRC Workflow → Hierarchy Flattening: flattens hierarchy (evidence: `README.md`)
- Hierarchy Flattening → Flat Layout: produces geometry (evidence: `README.md`)
- DRC Workflow → PDK Configuration: loads PDK (evidence: `README.md`)
- PDK Configuration → Virtual Layers: lowers layers (evidence: `src/pdk.rs`)
- DRC Workflow → Rule Dispatch: runs rules (evidence: `README.md`)
- Rule Dispatch → Spacing Checks: dispatches checks (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Width Checks: dispatches checks (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Density Checks: dispatches checks (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Shape Checks: dispatches checks (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Residual Checks: dispatches checks (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Edge Distance: dispatches checks (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Rule Parameters: reads parameters (evidence: `src/checks/mod.rs`)
- Rule Dispatch → Flat Layout: checks layers (evidence: `README.md`)
- Spacing Checks → Net Extraction: uses net data (evidence: `src/checks/space/mod.rs`)
- Net Extraction → Geometry Merge: uses geometry (evidence: `src/connectivity.rs`)
- Net Extraction → Flat Layout: reads shapes (evidence: `src/connectivity.rs`)
- Net Extraction → Memory Support: uses memory (evidence: `src/connectivity.rs`)
- Spacing Checks → Geometry Merge: uses merged shapes (evidence: `src/checks/space/mod.rs`)
- Density Checks → Geometry Merge: uses merged shapes (evidence: `src/checks/density/mod.rs`)
- Width Checks → Geometry Merge: uses merged shapes (evidence: `src/checks/width/mod.rs`)
- DRC Workflow → Violation Records: collects findings (evidence: `README.md`)
- Rule Dispatch → Violation Records: returns findings (evidence: `src/checks/mod.rs`)
- DRC Workflow → Report Writer: writes results (evidence: `README.md`)
- Report Writer → LYRDB Report: serializes report (evidence: `README.md`)
