Compare commits

...
Author SHA1 Message Date
rsp2k fa20dc5623 Merge main into feat/reduce-vias 2026-10-07 20:54:02 -06:00
rsp2k b9fed0fc4d Merge feat/verify-output: check grid and room output on exact shapes, --strict 2026-10-07 20:12:51 -06:00
rsp2k 8cb7a627f0 Add --reduce-vias and --via-cost to the exact engine
--reduce-vias is a last stage: each net that has vias is routed again on
its own with vias made eight times dearer, everything else held as fixed
copper (the window stage's board), and its new copper is kept only if the
net fails nothing new and has fewer vias; the nets with the most vias go
first, within a share of the routing's own time. --via-cost exposes the
search's layer-change price (default 10 grid steps). bench.py records
each run's via count and prints via totals per variant.
2026-10-07 20:06:00 -06:00
rsp2k 74d97b601c Check grid and room output on exact shapes and report shorts
The grid and room engines write copper they never check. After a grid or
room run the result is now put through the exact engine's geometry (its
pads, fixed copper and keepouts; wires as boxes or slanted slabs; vias as
their pads) and the report gives the shorts and clearance violations, with
examples, instead of a blanket warning. --strict exits 3 when there are any;
by default the exit status stays 0 so the JAR drop-in contract holds.

The exact engine's static-copper setup moves into insert_static_copper so
both use it; exact runs are byte-identical before and after.
2026-10-07 20:04:04 -06:00
rsp2k 1852df3d53 Merge fix/default-exact: exact engine by default, warn on unchecked engines 2026-10-07 18:52:10 -06:00
rsp2k 33de21ba0e Route with the exact engine by default; warn when an engine does not check
The grid engine was the default and its copper is not checked against exact
shapes: a full reroute of the Labrador lid with no flags came out with 15
tracks_crossing and 87 clearance violations under KiCad's DRC while the
report listed only unrouted connections. The exact engine (what mckicad and
every benchmark already use) is now the default, and grid or room runs end
with a warning that their output needs a DRC.
2026-10-07 18:37:33 -06:00
rsp2k 3b29edc624 Merge feat/rename-rpmroute: the router is now rpmroute (freeroute kept as an alias) 2026-10-07 17:35:56 -06:00
rsp2k a6aa1991a1 Rename to rpmroute
The router began as a port of FreeRouting and has grown its own engine
(negotiated congestion, tree nets, exact checks, axis escapes), and
'freeroute' was one letter from the project it no longer follows. The
package, module and command are now rpmroute; the freeroute command stays
as an alias, and the RPMROUTE / RPMROUTE_ORACLE_JAVA variables fall back
to the old FREEROUTE names. Version 2026.10.07. Routing is unchanged: a
PCBench board routes to a byte-identical session either way.
2026-10-07 14:10:36 -06:00
rsp2k 45aee463a8 Merge feat/window-reroute: opt-in --window-reroute, budgeted finer-grid windows around stuck connections 2026-10-07 14:00:39 -06:00
rsp2k d1def2c4b9 Window boards: never search a connection ending outside the window
With items away from the window left off its board, a stub from the window
edge out to a rerouted net's far pin crossed copper the exact check never
saw: 38 shorts on th-eda's flight controller. A connection with an end
outside the bounds is now left unrouted, and a window whose new copper
leaves the window is refused.
2026-10-06 23:07:09 -06:00
rsp2k 28523bcbac Window re-route: time budget, window cap, smallest first, window boards
A window's board now holds every pin and piece of copper of the nets it
reroutes and, of the rest, only items near the window, instead of the whole
board rebuilt per window. The smallest windows go first, at most
--window-cap per round (40), and no window starts once --window-budget of
the routing's own time is spent (0.25). On th-eda's flight controller the
stage had taken 12x the routing time for no gain.
2026-10-06 22:51:51 -06:00
rsp2k 27f7202d2f --window-reroute N: route a finer grid around each connection still stuck
After the exact engine, every net routed wholly inside a window around a
stuck connection's pins is ripped, the rest of the board is laid down as
fixed copper, and the window alone is routed again at --window-resolution
(default 4) with the stuck net and the ripped nets only. The result is kept
only if fewer connections are left unrouted; each round doubles the margin.
The grid and exact routers gain only_nets and bounds for it. Off by default.
2026-10-06 15:04:02 -06:00
rsp2k 95c89032e3 Merge feat/tree-nets: multi-pin nets route as trees, legs tee into routed copper 2026-10-05 17:12:32 -06:00
rsp2k 61f51129e1 A T depends on every connection between its copper and its group
Anchoring a T only on the connection whose copper it touched missed the
connections that tie that copper to the T's own group. When one of those
was ripped, the T stayed routed but cut off: on charge-sense freeroute
counted 15 unrouted while KiCad found 27 opens. Routed connections of a net
form a forest, so the path back is unique; the T now depends on all of it.
KiCad's opens and freeroute's count agree again (18 against 17, the extra
one a GND pour island left to the fill).
2026-10-05 12:58:58 -06:00
rsp2k b91e44e360 Route multi-pin nets as trees: spanning-tree pairs, T into routed copper
A net's pin groups were joined as a chain in pin order, and each
connection had to end on one chosen pin. Groups are now paired by a
minimum spanning tree (Manhattan distance between their nearest pins), and
a connection may start or end on any copper its net has already routed on
that side (path cells, via cells on every layer; not walled cells, whose
via moves into the pad). Plane nets keep their drops to the plane.

A connection that tees onto another records it as an anchor. Ripping a
connection rips what hangs on it, transitively, inside the same rip-up
transaction, so rollback restores all of them. The exact engine gets the
connections in commit order with their anchors and drops a T whose anchor
it rejects. --no-tree restores the chain.
2026-10-05 12:21:00 -06:00
rsp2k 89d6d8d9dd Merge feat/diagonal-escapes: pins of turned parts leave along their pad axis 2026-10-03 22:08:57 -06:00
rsp2k c6297656a6 Let pins on turned fine-pitch pads leave along the pad's axis
A QFN placed at 45 degrees had no exit on the grid: every horizontal or
vertical step from a pin passes its neighbours inside clearance. A pin whose
pad is turned more than ten degrees off the grid axes now leaves along the
pad's own axis, away from the part, until an L from there to a grid cell
clears every other net's pad, then searches as usual. The slanted leg is
checked and stored as an exact slab (segment_slab), not its bounding box,
in the grid stub checks and in the exact engine.

Where pins leave side by side, a cell names only its first owner, so stubs
are also indexed per cell for every connection near them; the exact
stub-vs-stub check, trace entry and rip-up all consult that index. A pin
with an axis exit and no clear cell reports no way out instead of falling
back to a cell on another net's route. diagnose.py replays with the exits.
2026-10-03 18:49:36 -06:00
rsp2k 4933b6f992 Merge feat/negotiated-congestion: --negotiate N, priced sharing and history before routing 2026-10-03 16:14:36 -06:00
rsp2k 6a560b9506 diagnose.py: --negotiate, as the router 2026-10-03 15:34:37 -06:00
rsp2k 09c58ea630 --negotiate: PathFinder rounds on the empty board before routing
Every connection is routed N times on the empty board, where routes may
share cells at a price that doubles each round for every other net on a
cell, and a cell that stays shared gains history. The real routing then
pays that history on free cells, so the first routes stop taking the space
later routes (a fine-pitch part's escapes) have no way round. Off by
default.

The old history term never steered: it only accrued at rip-up fights,
after the first routes had claimed the contested space, and routed
connections are never revisited in later passes.
2026-10-03 14:45:59 -06:00
rsp2k 7c076d9995 Merge fix/minisumo: shared-via owners for search and rip-up, round vias against the outline 2026-10-03 11:31:01 -06:00
rsp2k 8f006fec25 Rip every user of a shared via, and judge vias round at the outline
Two connections of a net can share a via. The grid kept one owner per via
cell next to the claim list, and the search and rip-up read only that owner:
a route of another net through the via ripped the first user and left the
second's via under the new trace. The exact check then threw one of them
out. The search and rip-up now read the claim list, and the single owner is
gone.

The exact check also tested a via against the outline as its square box,
whose corner reaches past a 45-degree chamfer where the round via does not.
The grid keeps the via's centre its radius plus the edge clearance from the
outline, as KiCad measures it; the exact check now does the same.

kitspace_minisumo_v3 seed 4: 4 rejected connections to 0, 11 failed to 7.
2026-10-03 11:03:38 -06:00
rsp2k ad10113b8b Merge fix/round-pads: route past round pads by their outline, not their bounding square 2026-10-02 04:51:51 -06:00
99 changed files with 2665 additions and 521 deletions
+4 -4
View File
@@ -1,12 +1,12 @@
# CLAUDE.md # CLAUDE.md
Guidance for Claude Code working in the `freeroute` repository. Guidance for Claude Code working in the `rpmroute` repository.
## What this is ## What this is
A native Python PCB autorouter: a Java-free reimplementation of the A native Python PCB autorouter: a Java-free reimplementation of the
[FreeRouting](https://github.com/freerouting/freerouting) engine. Specctra DSN [FreeRouting](https://github.com/freerouting/freerouting) engine. Specctra DSN
in, Specctra SES out, no JVM anywhere. Published on PyPI as `freeroute` in, Specctra SES out, no JVM anywhere. Published on PyPI as `rpmroute`
(GPL-3.0-or-later, CalVer). (GPL-3.0-or-later, CalVer).
## Commands ## Commands
@@ -16,7 +16,7 @@ uv sync
uv run pytest -m "not oracle" # the fast suite (this is what you run) uv run pytest -m "not oracle" # the fast suite (this is what you run)
uv run pytest -m oracle # differential tests against the real JAR (needs Java) uv run pytest -m oracle # differential tests against the real JAR (needs Java)
uv run ruff check src/ tests/ uv run ruff check src/ tests/
uv run freeroute board.dsn --engine room --pack -do board.ses uv run rpmroute board.dsn --engine room --pack -do board.ses
``` ```
## The three non-negotiable invariants ## The three non-negotiable invariants
@@ -67,7 +67,7 @@ route/ grid_router | exact_router | room_router, shove, pipeline, cli
decomposed into convex rooms joined by doors, so it routes off-grid channels decomposed into convex rooms joined by doors, so it routes off-grid channels
the grid literally cannot see. DRC-clean. Supports `--pack` and `--shove`. the grid literally cannot see. DRC-clean. Supports `--pack` and `--shove`.
The engine/option matrix lives in `freeroute.cli.ENGINE_OPTIONS` and is The engine/option matrix lives in `rpmroute.cli.ENGINE_OPTIONS` and is
importable, so consumers can assert against it. **An unsupported combination is importable, so consumers can assert against it. **An unsupported combination is
a hard error (exit 2), never a silent no-op.** Downstream code (`mckicad`) reads a hard error (exit 2), never a silent no-op.** Downstream code (`mckicad`) reads
this matrix to avoid sending an invalid pair. this matrix to avoid sending an invalid pair.
+26 -17
View File
@@ -1,14 +1,23 @@
# freeroute # rpmroute
A native Python PCB autorouter: a Java-free reimplementation of the A native Python PCB autorouter. Specctra DSN in, Specctra SES out, no JVM
[FreeRouting](https://github.com/freerouting/freerouting) engine. Specctra DSN anywhere in the pipeline.
in, Specctra SES out, no JVM anywhere in the pipeline.
It began as a Java-free port of the
[FreeRouting](https://github.com/freerouting/freerouting) engine and has grown
its own router since: negotiated congestion before routing, multi-pin nets
routed as trees, every route checked against exact pad and copper shapes, and
pin escapes along the pad's own axis for parts placed at an angle. On dense
boards it now finishes more connections than the FreeRouting JAR, with no
rule violations.
It was called `freeroute` until 2026-10-07; that command still works.
## Why ## Why
Toolchains that autoroute (`kicad-mcp` among them) do it by shelling out to Toolchains that autoroute (`kicad-mcp` among them) do it by shelling out to
`freerouting.jar`, which drags a JVM into every install and container image. `freerouting.jar`, which drags a JVM into every install and container image.
`freeroute` reimplements the routing engine in pure Python, with no dependencies `rpmroute` reimplements the routing engine in pure Python, with no dependencies
beyond the standard library, so the JAR step becomes a `pip install`. beyond the standard library, so the JAR step becomes a `pip install`.
## The contract ## The contract
@@ -16,31 +25,31 @@ beyond the standard library, so the JAR step becomes a `pip install`.
The entire integration surface is two Specctra files: The entire integration surface is two Specctra files:
``` ```
board.dsn ──▶ freeroute ──▶ board.ses board.dsn ──▶ rpmroute ──▶ board.ses
(unrouted) (routed session: traces + vias) (unrouted) (routed session: traces + vias)
``` ```
`kicad-cli` already exports `.dsn` and imports `.ses`, so `freeroute` drops in `kicad-cli` already exports `.dsn` and imports `.ses`, so `rpmroute` drops in
wherever `java -jar freerouting.jar` was invoked, and nothing else in the pipeline wherever `java -jar freerouting.jar` was invoked, and nothing else in the pipeline
changes. The `-de` / `-do` / `-mp` flags are the JAR's, on purpose. changes. The `-de` / `-do` / `-mp` flags are the JAR's, on purpose.
## Install ## Install
```bash ```bash
uv tool install freeroute # or: pipx install freeroute uv tool install rpmroute # or: pipx install rpmroute
``` ```
## Usage ## Usage
```bash ```bash
# a KiCad board: the exact engine, with the board's copper-to-edge rule # a KiCad board: the exact engine, with the board's copper-to-edge rule
freeroute board.dsn --engine exact --shove --edge-clearance 0.5 -do board.ses rpmroute board.dsn --engine exact --shove --edge-clearance 0.5 -do board.ses
freeroute -de board.dsn -do board.ses # the FreeRouting JAR spelling (grid engine) rpmroute -de board.dsn -do board.ses # the FreeRouting JAR spelling (grid engine)
freeroute board.dsn --engine room --pack --shove -do board.ses rpmroute board.dsn --engine room --pack --shove -do board.ses
``` ```
With no `-do` / `-o`, the SES goes to stdout. Connections freeroute could not With no `-do` / `-o`, the SES goes to stdout. Connections rpmroute could not
make are listed on stderr; the SES is still written and the exit code stays 0, make are listed on stderr; the SES is still written and the exit code stays 0,
as with the JAR. Connections whose two ends sit in one zone of their net are as with the JAR. Connections whose two ends sit in one zone of their net are
listed separately, as left to that zone's fill. listed separately, as left to that zone's fill.
@@ -99,7 +108,7 @@ What the opt-in passes buy you:
- **`--diagonal`** (exact): a still-dropped 2-pin net is retried as a 45° trace - **`--diagonal`** (exact): a still-dropped 2-pin net is retried as a 45° trace
covered by an exact integer octagon. covered by an exact integer octagon.
## What freeroute reads from a KiCad DSN ## What rpmroute reads from a KiCad DSN
These were each checked against KiCad itself, pad by pad or with its DRC: These were each checked against KiCad itself, pad by pad or with its DRC:
@@ -125,7 +134,7 @@ SES coordinates are written in resolution units, exactly as the JAR writes them.
## Library use ## Library use
```python ```python
from freeroute.route import route from rpmroute.route import route
ses_text = route(dsn_text, engine="exact", shove=True, edge_clearance_mm=0.5) ses_text = route(dsn_text, engine="exact", shove=True, edge_clearance_mm=0.5)
``` ```
@@ -136,13 +145,13 @@ Alpha. Measured on two real KiCad 10 boards (the TerraHawk charge node's power
stage and sense board, 2026-09-27), with every track stripped, then routed, then stage and sense board, 2026-09-27), with every track stripped, then routed, then
checked with `kicad-cli pcb drc --refill-zones`: checked with `kicad-cli pcb drc --refill-zones`:
| board | freeroute exact | FreeRouting JAR | DRC errors from freeroute | | board | rpmroute exact | FreeRouting JAR | DRC errors from rpmroute |
|---|---|---|---| |---|---|---|---|
| power stage (40 x 30 mm) | 7 unconnected, ~5 s | 12 | 0 | | power stage (40 x 30 mm) | 7 unconnected, ~5 s | 12 | 0 |
| sense board (55 x 25 mm, 0.5 mm pitch MCU) | 41 unconnected, ~2.5 min | 32 | 0 | | sense board (55 x 25 mm, 0.5 mm pitch MCU) | 41 unconnected, ~2.5 min | 32 | 0 |
In the board owner's production flow (hand-routed power lanes kept, pours added In the board owner's production flow (hand-routed power lanes kept, pours added
after routing), freeroute completed the power stage with no unconnected items. after routing), rpmroute completed the power stage with no unconnected items.
What it is **not**, stated plainly: What it is **not**, stated plainly:
@@ -164,7 +173,7 @@ What it is **not**, stated plainly:
For maximum completion on a dense board today, the JAR is still the stronger For maximum completion on a dense board today, the JAR is still the stronger
router. For routing without a JVM (CI, containers, an MCP server, a library router. For routing without a JVM (CI, containers, an MCP server, a library
call), freeroute routes legally and says what it could not do. call), rpmroute routes legally and says what it could not do.
## Development ## Development
+21 -6
View File
@@ -37,8 +37,8 @@ import tempfile
import threading import threading
import time import time
NOT_ROUTED = re.compile(r"freeroute: (\d+) connection\(s\) not routed") NOT_ROUTED = re.compile(r"rpmroute: (\d+) connection\(s\) not routed")
TO_ZONE = re.compile(r"freeroute: (\d+) more connection\(s\) left to a zone fill") TO_ZONE = re.compile(r"rpmroute: (\d+) more connection\(s\) left to a zone fill")
def parse_boards(path: Path) -> list[tuple[str, Path, list[str]]]: def parse_boards(path: Path) -> list[tuple[str, Path, list[str]]]:
@@ -61,8 +61,8 @@ def parse_variant(spec: str) -> tuple[str, str | None, list[str]]:
if not sep or not head: if not sep or not head:
raise SystemExit(f"variant {spec!r}: want NAME=FLAGS or NAME@SRC=FLAGS") raise SystemExit(f"variant {spec!r}: want NAME=FLAGS or NAME@SRC=FLAGS")
name, _, src = head.partition("@") name, _, src = head.partition("@")
if src and not (Path(src) / "freeroute").is_dir(): if src and not (Path(src) / "rpmroute").is_dir():
raise SystemExit(f"variant {name}: {src} has no freeroute package") raise SystemExit(f"variant {name}: {src} has no rpmroute package")
return name, src or None, shlex.split(flags) return name, src or None, shlex.split(flags)
@@ -74,7 +74,7 @@ def run_one(board, variant, seed: int, timeout: float) -> dict:
env["PYTHONPATH"] = src + os.pathsep + env.get("PYTHONPATH", "") env["PYTHONPATH"] = src + os.pathsep + env.get("PYTHONPATH", "")
with tempfile.TemporaryDirectory() as tmp: with tempfile.TemporaryDirectory() as tmp:
cmd = [ cmd = [
sys.executable, "-m", "freeroute.cli", str(dsn), "-do", f"{tmp}/out.ses", sys.executable, "-m", "rpmroute.cli", str(dsn), "-do", f"{tmp}/out.ses",
*board_flags, *flags, "--seed", str(seed), *board_flags, *flags, "--seed", str(seed),
] ]
start = time.monotonic() start = time.monotonic()
@@ -100,13 +100,18 @@ def run_one(board, variant, seed: int, timeout: float) -> dict:
) )
rss_mb = round(usage.ru_maxrss / 1024) rss_mb = round(usage.ru_maxrss / 1024)
secs = round(time.monotonic() - start, 1) secs = round(time.monotonic() - start, 1)
try:
with open(f"{tmp}/out.ses", encoding="utf-8") as f:
vias = f.read().count("(via ")
except OSError:
vias = None
missing = NOT_ROUTED.search(err) missing = NOT_ROUTED.search(err)
zone = TO_ZONE.search(err) zone = TO_ZONE.search(err)
return { return {
"board": name, "variant": vname, "seed": seed, "status": status, "board": name, "variant": vname, "seed": seed, "status": status,
"unrouted": int(missing.group(1)) if missing else 0, "unrouted": int(missing.group(1)) if missing else 0,
"to_zone": int(zone.group(1)) if zone else 0, "to_zone": int(zone.group(1)) if zone else 0,
"secs": secs, "rss_mb": rss_mb, "secs": secs, "rss_mb": rss_mb, "vias": vias,
"tail": err.strip().splitlines()[-1] if status != "ok" and err.strip() else "", "tail": err.strip().splitlines()[-1] if status != "ok" and err.strip() else "",
} }
@@ -147,6 +152,16 @@ def report(rows: list[dict], boards, variants) -> None:
line += (f" {dm:+.1f} ± {se:.1f} ({better} better, {worse} worse," line += (f" {dm:+.1f} ± {se:.1f} ({better} better, {worse} worse,"
f" {len(diffs) - better - worse} same) {verdict}") f" {len(diffs) - better - worse} same) {verdict}")
print(line) print(line)
# vias, where the runs recorded them (older result files did not)
print("\nvias per variant, summed over boards (mean over seeds per board)\n")
for vname, _, _ in variants:
total, boards_counted = 0.0, 0
for bname, _, _ in boards:
vs = [r["vias"] for k, r in ok.items() if k[:2] == (bname, vname) and r.get("vias") is not None]
if vs:
total += sum(vs) / len(vs)
boards_counted += 1
print(f"{vname:14} {total:8.1f} vias over {boards_counted} boards")
failed = [r for r in rows if r["status"] != "ok"] failed = [r for r in rows if r["status"] != "ok"]
for r in failed: for r in failed:
print(f"FAILED {r['board']} {r['variant']} seed {r['seed']}: {r['status']} {r['tail']}") print(f"FAILED {r['board']} {r['variant']} seed {r['seed']}: {r['status']} {r['tail']}")
+14 -9
View File
@@ -23,14 +23,14 @@ import json
from pathlib import Path from pathlib import Path
import sys import sys
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.board.search_tree import ShapeSearchTree from rpmroute.board.search_tree import ShapeSearchTree
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.geometry.octagon import overlaps_2d from rpmroute.geometry.octagon import overlaps_2d
from freeroute.route import grid_router from rpmroute.route import grid_router
from freeroute.route.exact_router import route_board_exact from rpmroute.route.exact_router import route_board_exact
from freeroute.route.grid_router import GridRouter, _ends_of from rpmroute.route.grid_router import GridRouter, _ends_of
from freeroute.route.pipeline import ( from rpmroute.route.pipeline import (
_mm_to_board, _mm_to_board,
_net_widths_board, _net_widths_board,
_rule_clearance_dsn, _rule_clearance_dsn,
@@ -186,6 +186,7 @@ def _flood(router: GridRouter, pin, net_no: int, conns) -> tuple[int, Counter]:
def diagnose( def diagnose(
dsn_text: str, edge_clearance_mm: float | None, resolution: int = 2, shove: bool = False, dsn_text: str, edge_clearance_mm: float | None, resolution: int = 2, shove: bool = False,
access_cost: float = 0.0, hole_to_hole_mm: float = 0.25, seed: int | None = None, access_cost: float = 0.0, hole_to_hole_mm: float = 0.25, seed: int | None = None,
negotiate: int = 0,
) -> dict: ) -> dict:
dsn = parse_dsn(dsn_text) dsn = parse_dsn(dsn_text)
names = {i + 1: n.name for i, n in enumerate(dsn.nets)} names = {i + 1: n.name for i, n in enumerate(dsn.nets)}
@@ -202,6 +203,7 @@ def diagnose(
shove=shove, shove=shove,
access_cost=access_cost, access_cost=access_cost,
seed=seed, seed=seed,
negotiate=negotiate,
# the product's configuration: net-class widths and hole spacing # the product's configuration: net-class widths and hole spacing
net_widths=_net_widths_board(dsn, scale), net_widths=_net_widths_board(dsn, scale),
via_drill=_via_drill_board(dsn, scale), via_drill=_via_drill_board(dsn, scale),
@@ -213,6 +215,8 @@ def diagnose(
# the board as the best pass left it # the board as the best pass left it
state = _fresh(seen) state = _fresh(seen)
# pins on turned pads leave along their pad's axis: replay with the same exits
state._axis_exits = dict(routed._axis_exits)
conns = state._conns conns = state._conns
for idx, (path, a_end, b_end) in best.items(): for idx, (path, a_end, b_end) in best.items():
conns[idx].a_end, conns[idx].b_end = a_end, b_end conns[idx].a_end, conns[idx].b_end = a_end, b_end
@@ -278,12 +282,13 @@ def main(argv: list[str] | None = None) -> int:
ap.add_argument("--shove", action="store_true", help="as mckicad routes") ap.add_argument("--shove", action="store_true", help="as mckicad routes")
ap.add_argument("--access-cost", type=float, default=0.0) ap.add_argument("--access-cost", type=float, default=0.0)
ap.add_argument("--seed", type=int, help="route in this shuffled order, as bench.py does") ap.add_argument("--seed", type=int, help="route in this shuffled order, as bench.py does")
ap.add_argument("--negotiate", type=int, default=0, metavar="N", help="as the router's --negotiate")
ap.add_argument("--hole-to-hole", type=float, default=0.25, metavar="MM") ap.add_argument("--hole-to-hole", type=float, default=0.25, metavar="MM")
ap.add_argument("--json", type=Path, help="also write the full table here") ap.add_argument("--json", type=Path, help="also write the full table here")
args = ap.parse_args(argv) args = ap.parse_args(argv)
report = diagnose(args.dsn.read_text(), args.edge_clearance, args.grid_resolution, args.shove, report = diagnose(args.dsn.read_text(), args.edge_clearance, args.grid_resolution, args.shove,
args.access_cost, args.hole_to_hole, args.seed) args.access_cost, args.hole_to_hole, args.seed, args.negotiate)
for row in report["failures"]: for row in report["failures"]:
extra = "" extra = ""
for w in row.get("walled", []): for w in row.get("walled", []):
+5 -5
View File
@@ -1,7 +1,7 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# Route one KiCad board with freeroute and judge the result with KiCad's DRC. # Route one KiCad board with rpmroute and judge the result with KiCad's DRC.
# #
# bench/drc_check.sh [--keep] <board.kicad_pcb> <out-dir> [freeroute args...] # bench/drc_check.sh [--keep] <board.kicad_pcb> <out-dir> [rpmroute args...]
# #
# Copies the board (and its .kicad_pro) into <out-dir>, strips its tracks and # Copies the board (and its .kicad_pro) into <out-dir>, strips its tracks and
# vias unless --keep is given (then they reach the router as fixed wiring), # vias unless --keep is given (then they reach the router as fixed wiring),
@@ -10,14 +10,14 @@
# shorts, opens, hole problems (whatever severity the board gives them) and # shorts, opens, hole problems (whatever severity the board gives them) and
# the other errors. The source board is never touched. # the other errors. The source board is never touched.
# #
# FREEROUTE (default: this checkout's .venv/bin/freeroute) and MCK (default # RPMROUTE (or the older FREEROUTE; default: this checkout's .venv/bin/rpmroute) and MCK (default
# ~/claude/mckicad) pick the builds to judge. # ~/claude/mckicad) pick the builds to judge.
set -euo pipefail set -euo pipefail
keep=0 keep=0
if [[ "${1:-}" == "--keep" ]]; then keep=1; shift; fi if [[ "${1:-}" == "--keep" ]]; then keep=1; shift; fi
src="$1"; out="$2"; shift 2 src="$1"; out="$2"; shift 2
here="$(cd "$(dirname "$0")/.." && pwd)" here="$(cd "$(dirname "$0")/.." && pwd)"
FREEROUTE="${FREEROUTE:-$here/.venv/bin/freeroute}" RPMROUTE="${RPMROUTE:-${FREEROUTE:-$here/.venv/bin/rpmroute}}"
MCK="${MCK:-$HOME/claude/mckicad}" MCK="${MCK:-$HOME/claude/mckicad}"
rm -rf "$out"; mkdir -p "$out" rm -rf "$out"; mkdir -p "$out"
cp "${src%.kicad_pcb}.kicad_pro" "$out/board.kicad_pro" 2>/dev/null || true cp "${src%.kicad_pcb}.kicad_pro" "$out/board.kicad_pro" 2>/dev/null || true
@@ -43,7 +43,7 @@ assert FreeRoutingEngine().export_dsn_from_kicad('$out/board.kicad_pcb', '$out/b
>/dev/null 2>&1 || { echo "$out: DSN export failed"; exit 1; } >/dev/null 2>&1 || { echo "$out: DSN export failed"; exit 1; }
start=$(date +%s.%N) start=$(date +%s.%N)
"$FREEROUTE" "$out/board.dsn" -do "$out/board.ses" "$@" >"$out/route.log" 2>&1 || true "$RPMROUTE" "$out/board.dsn" -do "$out/board.ses" "$@" >"$out/route.log" 2>&1 || true
secs=$(python3 -c "print(round($(date +%s.%N)-$start,1))") secs=$(python3 -c "print(round($(date +%s.%N)-$start,1))")
[[ -s "$out/board.ses" ]] || { echo "$out: no session ($(tail -1 "$out/route.log"))"; exit 1; } [[ -s "$out/board.ses" ]] || { echo "$out: no session ($(tail -1 "$out/route.log"))"; exit 1; }
+3 -3
View File
@@ -90,7 +90,7 @@ this is the structure the Python `reader.py` mirrors):
**Python port status:** items 1 (tokenizer), the shape grammar, and every **Python port status:** items 1 (tokenizer), the shape grammar, and every
structure/library/network/placement/parser/resolution scope above are structure/library/network/placement/parser/resolution scope above are
implemented in `src/freeroute/dsn/` this session (see below). implemented in `src/rpmroute/dsn/` this session (see below).
## 2. Board data model — `board/` ## 2. Board data model — `board/`
@@ -175,7 +175,7 @@ converge toward FreeRouting's free-space rooms. Not started this session.
into the read result). into the read result).
## Port order (this file drives the roadmap) ## Port order (this file drives the roadmap)
1. **DSN parser** — done this session (`src/freeroute/dsn/`). 1. **DSN parser** — done this session (`src/rpmroute/dsn/`).
2. **SES writer** — next. Start with an empty/no-op session to prove the loop 2. **SES writer** — next. Start with an empty/no-op session to prove the loop
end-to-end through `kicad-cli pcb import specctra-ses`. See `SesWriter.java` end-to-end through `kicad-cli pcb import specctra-ses`. See `SesWriter.java`
and `SpecctraSesFileWriter.java`: `(session <name> (base_design <name>) and `SpecctraSesFileWriter.java`: `(session <name> (base_design <name>)
@@ -184,6 +184,6 @@ converge toward FreeRouting's free-space rooms. Not started this session.
3. **Geometry primitives** — `geometry/planar` subset needed by the board model. 3. **Geometry primitives** — `geometry/planar` subset needed by the board model.
4. **Board model** — `board` items + spatial index. 4. **Board model** — `board` items + spatial index.
5. **Autorouter** — maze/rip-up core, then optimize pass. 5. **Autorouter** — maze/rip-up core, then optimize pass.
6. **CLI + kicad-mcp integration** — `freeroute board.dsn -o board.ses`. 6. **CLI + kicad-mcp integration** — `rpmroute board.dsn -o board.ses`.
</content> </content>
</invoke> </invoke>
+1 -1
View File
@@ -43,7 +43,7 @@ the output. Match that I/O and the rest of `kicad-mcp` is unchanged.
4. **Autorouter core** — maze routing with rip-up-and-retry. Start grid-based 4. **Autorouter core** — maze routing with rip-up-and-retry. Start grid-based
Manhattan/45° for an MVP; converge toward FreeRouting's approach. _(TBD.)_ Manhattan/45° for an MVP; converge toward FreeRouting's approach. _(TBD.)_
5. **Optimize pass** — via minimization, trace smoothing. _(TBD.)_ 5. **Optimize pass** — via minimization, trace smoothing. _(TBD.)_
6. **CLI + kicad-mcp integration** — `freeroute board.dsn -o board.ses`, then 6. **CLI + kicad-mcp integration** — `rpmroute board.dsn -o board.ses`, then
swap it in behind `kicad_mcp/utils/freerouting_engine.py`'s JAR step. swap it in behind `kicad_mcp/utils/freerouting_engine.py`'s JAR step.
## Validation strategy ## Validation strategy
+14 -11
View File
@@ -3,9 +3,9 @@ requires = ["hatchling"]
build-backend = "hatchling.build" build-backend = "hatchling.build"
[project] [project]
name = "freeroute" name = "rpmroute"
version = "2026.07.14" version = "2026.10.07"
description = "Native Python PCB autorouter — a Java-free port of the FreeRouting engine (Specctra DSN in, SES out)" description = "Native Python PCB autorouter with negotiated congestion and tree routing (Specctra DSN in, SES out)"
readme = "README.md" readme = "README.md"
license = "GPL-3.0-or-later" license = "GPL-3.0-or-later"
license-files = ["LICENSE"] license-files = ["LICENSE"]
@@ -40,14 +40,17 @@ requires-python = ">=3.10"
dependencies = [] dependencies = []
[project.urls] [project.urls]
"Homepage" = "https://git.supported.systems/warehack.ing/freeroute" "Homepage" = "https://git.supported.systems/warehack.ing/rpmroute"
"Repository" = "https://git.supported.systems/warehack.ing/freeroute" "Repository" = "https://git.supported.systems/warehack.ing/rpmroute"
"Issues" = "https://git.supported.systems/warehack.ing/freeroute/issues" "Issues" = "https://git.supported.systems/warehack.ing/rpmroute/issues"
# The Java engine this is a port of; freeroute ships no upstream code. # Where it started: a port of the Java FreeRouting engine. It has since grown
"Upstream" = "https://github.com/freerouting/freerouting" # its own router (negotiation, tree nets, exact checks) and ships no upstream code.
"Origin" = "https://github.com/freerouting/freerouting"
[project.scripts] [project.scripts]
freeroute = "freeroute.cli:main" rpmroute = "rpmroute.cli:main"
# the name it had until 2026-10-07, kept so existing scripts keep working
freeroute = "rpmroute.cli:main"
[dependency-groups] [dependency-groups]
dev = [ dev = [
@@ -57,7 +60,7 @@ dev = [
] ]
[tool.hatch.build.targets.wheel] [tool.hatch.build.targets.wheel]
packages = ["src/freeroute"] packages = ["src/rpmroute"]
[tool.hatch.build.targets.sdist] [tool.hatch.build.targets.sdist]
# Ship the package, the licence, and the docs — nothing else. `reference/` is a # Ship the package, the licence, and the docs — nothing else. `reference/` is a
@@ -95,7 +98,7 @@ select = ["E", "W", "F", "I", "B", "C4", "UP", "SIM"]
ignore = ["E501"] ignore = ["E501"]
[tool.ruff.lint.isort] [tool.ruff.lint.isort]
known-first-party = ["freeroute"] known-first-party = ["rpmroute"]
force-sort-within-sections = true force-sort-within-sections = true
[tool.pytest.ini_options] [tool.pytest.ini_options]
-3
View File
@@ -1,3 +0,0 @@
"""freeroute — native Python PCB autorouter (Java-free FreeRouting port)."""
__version__ = "0.1.0"
+3
View File
@@ -0,0 +1,3 @@
"""rpmroute — native Python PCB autorouter (Java-free FreeRouting port)."""
__version__ = "0.1.0"
@@ -1,9 +1,9 @@
"""Board data model for freeroute. """Board data model for rpmroute.
The data model a parsed DSN produces and the (future) router operates on: The data model a parsed DSN produces and the (future) router operates on:
layers, units, coordinate transform, nets, clearance matrix, the item hierarchy, layers, units, coordinate transform, nets, clearance matrix, the item hierarchy,
and the :class:`BasicBoard` container. :func:`build_board` constructs a board and the :class:`BasicBoard` container. :func:`build_board` constructs a board
from a :class:`~freeroute.dsn.model.DsnBoard`. from a :class:`~rpmroute.dsn.model.DsnBoard`.
The routing operations (``RoutingBoard``) and the spatial ``ShapeSearchTree`` The routing operations (``RoutingBoard``) and the spatial ``ShapeSearchTree``
belong to the router phase. belong to the router phase.
@@ -9,7 +9,7 @@ board-model invariants check.
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import IntBox from rpmroute.geometry import IntBox
from .clearance import ClearanceMatrix from .clearance import ClearanceMatrix
from .items import ConductionArea, Item, ObstacleArea, Pin, Trace, Via from .items import ConductionArea, Item, ObstacleArea, Pin, Trace, Via
@@ -74,7 +74,7 @@ class BasicBoard:
"""Copper already routed on the board (the DSN's ``wiring``), as """Copper already routed on the board (the DSN's ``wiring``), as
``(net, layers, box)``. A track is its segments, its corners and the ``(net, layers, box)``. A track is its segments, its corners and the
round caps at its ends (as squares); a via is its largest pad.""" round caps at its ends (as squares); a via is its largest pad."""
from freeroute.geometry.polyline import Polyline, PolylineShape, corner_box from rpmroute.geometry.polyline import Polyline, PolylineShape, corner_box
out: list[tuple[int, frozenset[int], IntBox]] = [] out: list[tuple[int, frozenset[int], IntBox]] = []
for item in self._items: for item in self._items:
@@ -1,6 +1,6 @@
"""Build a :class:`BasicBoard` from a parsed DSN :class:`DsnBoard`. """Build a :class:`BasicBoard` from a parsed DSN :class:`DsnBoard`.
This is the load-bearing integration between :mod:`freeroute.dsn` and the board This is the load-bearing integration between :mod:`rpmroute.dsn` and the board
model. It mirrors what FreeRouting's ``Structure.create_board`` / ``Library`` / model. It mirrors what FreeRouting's ``Structure.create_board`` / ``Library`` /
``Component`` / ``Network`` readers do collectively, but on the already-parsed ``Component`` / ``Network`` readers do collectively, but on the already-parsed
``DsnBoard``: ``DsnBoard``:
@@ -26,10 +26,10 @@ from __future__ import annotations
import math import math
import re import re
from freeroute.dsn.model import DsnBoard from rpmroute.dsn.model import DsnBoard
from freeroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape from rpmroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape
from freeroute.geometry import FloatPoint, IntBox, IntPoint, IntVector, Simplex from rpmroute.geometry import FloatPoint, IntBox, IntPoint, IntVector, Simplex
from freeroute.geometry.polygon_shape import PolygonShape from rpmroute.geometry.polygon_shape import PolygonShape
from .board import BasicBoard from .board import BasicBoard
from .clearance import ClearanceMatrix from .clearance import ClearanceMatrix
@@ -3,22 +3,22 @@
Ports the *data model* of ``board/Item.java`` and its subclasses (``Pin``, Ports the *data model* of ``board/Item.java`` and its subclasses (``Pin``,
``ObstacleArea``/``ConductionArea``, ``Via``, ``PolylineTrace``). The routing ``ObstacleArea``/``ConductionArea``, ``Via``, ``PolylineTrace``). The routing
and search-tree machinery in the Java classes is out of scope here — these hold and search-tree machinery in the Java classes is out of scope here — these hold
the geometry and connectivity a :class:`~freeroute.board.board.BasicBoard` the geometry and connectivity a :class:`~rpmroute.board.board.BasicBoard`
needs and that the DSN-import invariants check. needs and that the DSN-import invariants check.
Coordinates are board units (DSN units scaled by the resolution). Shapes are the Coordinates are board units (DSN units scaled by the resolution). Shapes are the
exact convex tiles / boxes from :mod:`freeroute.geometry`. exact convex tiles / boxes from :mod:`rpmroute.geometry`.
``Trace``/``Via`` are only produced by routing (an imported unrouted board has ``Trace``/``Via`` are only produced by routing (an imported unrouted board has
none); they are lightweight here and the router phase fleshes out none); they are lightweight here and the router phase fleshes out
``Trace`` with a proper :class:`~freeroute.geometry.Polyline` shape. ``Trace`` with a proper :class:`~rpmroute.geometry.Polyline` shape.
""" """
from __future__ import annotations from __future__ import annotations
from dataclasses import dataclass, field from dataclasses import dataclass, field
from freeroute.geometry import IntBox, IntPoint from rpmroute.geometry import IntBox, IntPoint
__all__ = ["Item", "Pin", "ObstacleArea", "ConductionArea", "Via", "Trace"] __all__ = ["Item", "Pin", "ObstacleArea", "ConductionArea", "Via", "Trace"]
@@ -126,7 +126,7 @@ class Trace(Item):
"""A routed trace (router-produced). """A routed trace (router-produced).
Held as its corner points plus a half-width; the router phase attaches the Held as its corner points plus a half-width; the router phase attaches the
full :class:`~freeroute.geometry.Polyline` swept shape. full :class:`~rpmroute.geometry.Polyline` swept shape.
""" """
layer: int = 0 layer: int = 0
@@ -9,7 +9,7 @@ from __future__ import annotations
import math import math
from freeroute.geometry import IntBox, IntPoint from rpmroute.geometry import IntBox, IntPoint
class BoardOutline: class BoardOutline:
@@ -2,7 +2,7 @@
Ports the query role of ``board/ShapeSearchTree*.java``. It replaces the exact Ports the query role of ``board/ShapeSearchTree*.java``. It replaces the exact
router's occupancy grid: instead of rasterizing shapes into cells, it indexes router's occupancy grid: instead of rasterizing shapes into cells, it indexes
each item's convex tiles (:class:`~freeroute.geometry.IntBox`) and answers each item's convex tiles (:class:`~rpmroute.geometry.IntBox`) and answers
overlap / region queries with a broad phase (a bounding-box spatial hash) and an overlap / region queries with a broad phase (a bounding-box spatial hash) and an
**exact** narrow phase (exact ``IntBox`` intersection). Insert and remove keep **exact** narrow phase (exact ``IntBox`` intersection). Insert and remove keep
the index in step as traces are added. the index in step as traces are added.
@@ -18,7 +18,7 @@ from __future__ import annotations
from dataclasses import dataclass from dataclasses import dataclass
from freeroute.geometry import IntBox, Simplex, overlaps_2d, segment_octagon from rpmroute.geometry import IntBox, IntPoint, Simplex, overlaps_2d, segment_octagon, segment_slab
__all__ = ["TreeShape", "ShapeSearchTree"] __all__ = ["TreeShape", "ShapeSearchTree"]
@@ -34,7 +34,7 @@ class TreeShape:
``exact`` / ``seg`` are set only for a 45-degree (diagonal) trace tile: ``tile`` ``exact`` / ``seg`` are set only for a 45-degree (diagonal) trace tile: ``tile``
is then the bounding box (broad-phase only), ``exact`` is the tight octagon is then the bounding box (broad-phase only), ``exact`` is the tight octagon
copper :class:`~freeroute.geometry.Simplex`, and ``seg`` is ``(a, b, copper :class:`~rpmroute.geometry.Simplex`, and ``seg`` is ``(a, b,
half_width)`` so the clearance region can be rebuilt exactly on demand. For half_width)`` so the clearance region can be rebuilt exactly on demand. For
every orthogonal tile both are ``None`` and all code paths are byte-identical every orthogonal tile both are ``None`` and all code paths are byte-identical
to the box-only tree. to the box-only tree.
@@ -63,7 +63,9 @@ class TreeShape:
segment swept by ``half_width + clearance`` (exact integer superset).""" segment swept by ``half_width + clearance`` (exact integer superset)."""
if self.seg is None: if self.seg is None:
return self.tile.offset(clearance) return self.tile.offset(clearance)
a, b, half_width = self.seg a, b, half_width = self.seg[-3:]
if self.seg[0] == "slab": # a slanted pin exit, at any angle
return segment_slab(a, b, half_width + clearance)
return segment_octagon(a, b, half_width + clearance) return segment_octagon(a, b, half_width + clearance)
@@ -151,6 +153,25 @@ class ShapeSearchTree:
return True return True
return False return False
def segment_conflict(
self, a: IntPoint, b: IntPoint, half_width: int, net_no: int, layer: int,
clearance: int, kind: str = "wire",
) -> bool:
""":meth:`clearance_conflict` for a slanted segment, checked on its
exact swept copper instead of its bounding box (which would reach the
neighbouring pads of a pin leaving along its turned pad's axis)."""
copper = segment_slab(a, b, half_width)
grown = segment_slab(a, b, half_width + clearance)
for shape in self.overlapping(grown.bounding_box()):
if shape.net_no == net_no or not shape.on_layer(layer):
continue
if shape.blocks != "all" and shape.blocks != kind + "s":
continue
other = shape.exact if shape.exact is not None else shape.tile
if overlaps_2d(copper if not shape.clearance else grown, other):
return True
return False
def rule_area_overlap(self, box: IntBox, layer: int, kind: str = "wire") -> bool: def rule_area_overlap(self, box: IntBox, layer: int, kind: str = "wire") -> bool:
"""True if ``box`` overlaps a rule area on ``layer`` that stops ``kind``.""" """True if ``box`` overlaps a rule area on ``layer`` that stops ``kind``."""
for shape in self.overlapping(box): for shape in self.overlapping(box):
@@ -216,3 +237,36 @@ class ShapeSearchTree:
if overlaps_2d(grown, other_tile): if overlaps_2d(grown, other_tile):
return shape return shape
return None return None
def violation_pairs(self, clearance: int) -> list[tuple[TreeShape, TreeShape, bool]]:
"""Every different-net pair sharing a layer, at least one of them
routed, whose coppers come closer than ``clearance``: ``(routed tile,
other tile, touching)``. ``touching`` is True when the coppers
themselves overlap (a short, or copper inside a keepout); False for a
clearance violation. Each pair of tiles is reported once.
:meth:`has_violation` asks whether there is one; this lists them all,
for a report on copper that no engine has checked.
"""
pairs: list[tuple[TreeShape, TreeShape, bool]] = []
seen: set[tuple[int, int]] = set()
for shape in self.all_shapes():
if not shape.routed:
continue
mine = shape.exact if shape.exact is not None else shape.tile
grown = shape.clearance_region(clearance)
for other in self.overlapping(grown.bounding_box()):
if other is shape or other.net_no == shape.net_no:
continue
if not (shape.layers & other.layers):
continue
key = (min(id(shape), id(other)), max(id(shape), id(other)))
if key in seen:
continue
theirs = other.exact if other.exact is not None else other.tile
touching = overlaps_2d(mine, theirs)
if not touching and (not other.clearance or not overlaps_2d(grown, theirs)):
continue # a rule area only counts an overlap
seen.add(key)
pairs.append((shape, other, touching))
return pairs
@@ -8,7 +8,7 @@ resolution`` and zero offset (see ``Structure.create_board``).
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import FloatPoint, IntPoint from rpmroute.geometry import FloatPoint, IntPoint
__all__ = ["CoordinateTransform"] __all__ = ["CoordinateTransform"]
+171 -20
View File
@@ -1,8 +1,8 @@
"""freeroute command-line interface: Specctra DSN in, routed SES out. """rpmroute command-line interface: Specctra DSN in, routed SES out.
Flag-compatible with the FreeRouting JAR (``-de`` / ``-do`` / ``-mp``) so it can Flag-compatible with the FreeRouting JAR (``-de`` / ``-do`` / ``-mp``) so it can
be dropped in wherever ``java -jar freerouting.jar`` was invoked, plus the be dropped in wherever ``java -jar freerouting.jar`` was invoked, plus the
freeroute-specific engine selection (``--engine``) and its opt-in passes. rpmroute-specific engine selection (``--engine``) and its opt-in passes.
Not every engine supports every pass. The matrix below is the single source of Not every engine supports every pass. The matrix below is the single source of
truth; an unsupported combination is an error, never a silent no-op:: truth; an unsupported combination is an error, never a silent no-op::
@@ -18,20 +18,27 @@ from __future__ import annotations
import argparse import argparse
import sys import sys
from freeroute.dsn.reader import parse_dsn from rpmroute.dsn.reader import parse_dsn
from freeroute.route.orders import best_of_orders, promote_failures from rpmroute.route.orders import best_of_orders, promote_failures
from freeroute.route.pipeline import ( from rpmroute.route.pipeline import (
build_exact_routing_result, build_exact_routing_result,
build_rooms_routing_result, build_rooms_routing_result,
build_routing_result, build_routing_result,
) )
from freeroute.ses import write_ses from rpmroute.route.verify import verify_result
from rpmroute.ses import write_ses
#: which optional flags each engine actually implements. Anything not listed for #: which optional flags each engine actually implements. Anything not listed for
#: an engine is rejected by :func:`_validate` rather than quietly ignored. #: an engine is rejected by :func:`_validate` rather than quietly ignored.
ENGINE_OPTIONS: dict[str, frozenset[str]] = { ENGINE_OPTIONS: dict[str, frozenset[str]] = {
"grid": frozenset({"rip_up", "max_passes", "seed", "orders", "promote", "access", "rollback"}), "grid": frozenset({
"exact": frozenset({"shove", "diagonal", "rip_up", "max_passes", "seed", "orders", "promote", "access", "rollback"}), "rip_up", "max_passes", "seed", "orders", "promote", "access", "negotiate", "rollback",
"tree", "via_cost",
}),
"exact": frozenset({
"shove", "diagonal", "rip_up", "max_passes", "seed", "orders", "promote", "access",
"negotiate", "rollback", "tree", "window", "vias", "via_cost",
}),
"room": frozenset({"shove", "pack"}), "room": frozenset({"shove", "pack"}),
} }
@@ -46,7 +53,12 @@ _FLAG_NAMES = {
"orders": "--orders", "orders": "--orders",
"promote": "--promote-failures", "promote": "--promote-failures",
"access": "--access-cost", "access": "--access-cost",
"negotiate": "--negotiate",
"rollback": "--no-rollback", "rollback": "--no-rollback",
"tree": "--no-tree",
"window": "--window-reroute",
"vias": "--reduce-vias",
"via_cost": "--via-cost",
} }
@@ -68,7 +80,7 @@ def _validate(parser: argparse.ArgumentParser, engine: str, requested: list[str]
def build_parser() -> argparse.ArgumentParser: def build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
prog="freeroute", prog="rpmroute",
description="Native PCB autorouter — route a Specctra DSN and write an SES session file.", description="Native PCB autorouter — route a Specctra DSN and write an SES session file.",
) )
parser.add_argument("dsn", nargs="?", help="input Specctra .dsn file") parser.add_argument("dsn", nargs="?", help="input Specctra .dsn file")
@@ -88,11 +100,12 @@ def build_parser() -> argparse.ArgumentParser:
parser.add_argument( parser.add_argument(
"--engine", "--engine",
choices=sorted(ENGINE_OPTIONS), choices=sorted(ENGINE_OPTIONS),
default="grid", default="exact",
help=( help=(
"routing track: grid (default; multi-layer rip-up maze, highest coverage), " "routing track: exact (default; every route checked against exact pad and "
"exact (orthogonal, exact-geometry DRC-verified output), " "copper shapes, DRC-clean output), grid (quick maze on the grid alone: its "
"room (continuous expansion rooms, routes off-grid channels)" "copper is NOT clearance-checked and can short), room (continuous expansion "
"rooms, routes off-grid channels; not clearance-checked either)"
), ),
) )
parser.add_argument( parser.add_argument(
@@ -167,6 +180,14 @@ def build_parser() -> argparse.ArgumentParser:
help="grid and exact engines: extra cost for a route to pass where it would close " help="grid and exact engines: extra cost for a route to pass where it would close "
"another pin's way out while that pin still has connections to route (default 0: off)", "another pin's way out while that pin still has connections to route (default 0: off)",
) )
parser.add_argument(
"--negotiate",
type=int,
metavar="N",
help="grid and exact engines: before routing, N rounds of negotiation on the empty "
"board, where routes may share space at a price that rises where they compete; "
"the contested cells then cost extra in the real routing (default 0: off)",
)
parser.add_argument( parser.add_argument(
"--no-rollback", "--no-rollback",
dest="rollback", dest="rollback",
@@ -175,6 +196,84 @@ def build_parser() -> argparse.ArgumentParser:
"connections a rip-up displaces are rerouted at once and the rip-up is undone " "connections a rip-up displaces are rerouted at once and the rip-up is undone "
"if fewer connections end up routed", "if fewer connections end up routed",
) )
parser.add_argument(
"--no-tree",
dest="tree_nets",
action="store_false",
help="grid and exact engines: join a multi-pin net's pins as a chain in pin "
"order, each connection ending on one chosen pin, as before. By default they are "
"paired by a minimum spanning tree and a connection may end on copper its net "
"has already routed",
)
parser.add_argument(
"--window-reroute",
type=int,
metavar="N",
help="exact engine: after routing, N rounds of window re-routes: around each "
"connection still unrouted, the nets routed wholly inside a window are ripped and "
"the window routed again on a finer grid, kept only if fewer connections are left "
"unrouted; each round doubles the window's margin (default 0: off)",
)
parser.add_argument(
"--window-resolution",
type=int,
default=4,
metavar="K",
help="the window re-route's grid resolution (default 4)",
)
parser.add_argument(
"--window-budget",
type=float,
default=0.25,
metavar="F",
help="the window re-route stops starting windows once it has spent this share "
"of the routing's own time (default 0.25)",
)
parser.add_argument(
"--window-cap",
type=int,
default=40,
metavar="W",
help="at most this many windows per round, smallest first (default 40)",
)
parser.add_argument(
"--window-margin",
type=float,
default=1.5,
metavar="MM",
help="the first round's window margin around the stuck connection's pins (default 1.5)",
)
parser.add_argument(
"--via-cost",
type=float,
default=None,
metavar="C",
help="grid and exact engines: what a layer change costs the search, in grid "
"steps of track (default 10)",
)
parser.add_argument(
"--reduce-vias",
action="store_true",
default=None,
help="exact engine: after routing, route each net that has vias again on its own "
"with vias made dearer, everything else held fixed; its new copper is kept only "
"if it fails nothing new and has fewer vias",
)
parser.add_argument(
"--reduce-vias-budget",
type=float,
default=0.5,
metavar="F",
help="via reduction stops starting nets once it has spent this share of the "
"routing's own time (default 0.5)",
)
parser.add_argument(
"--reduce-vias-margin",
type=float,
default=2.0,
metavar="MM",
help="how far past its pins and copper a net may go when routed again (default 2.0)",
)
parser.add_argument( parser.add_argument(
"--hole-to-hole", "--hole-to-hole",
type=float, type=float,
@@ -189,6 +288,15 @@ def build_parser() -> argparse.ArgumentParser:
metavar="J", metavar="J",
help="processes for --orders (default: one per order, up to the CPU count)", help="processes for --orders (default: one per order, up to the CPU count)",
) )
parser.add_argument(
"--strict",
action="store_true",
help=(
"exit with status 3 when the routed copper has shorts or clearance "
"violations (grid and room output is checked after routing; the "
"session file is still written)"
),
)
return parser return parser
@@ -212,7 +320,12 @@ def main(argv: list[str] | None = None) -> int:
("orders", args.orders is not None), ("orders", args.orders is not None),
("promote", args.promote_failures is not None), ("promote", args.promote_failures is not None),
("access", args.access_cost is not None), ("access", args.access_cost is not None),
("negotiate", args.negotiate is not None),
("rollback", not args.rollback), ("rollback", not args.rollback),
("tree", not args.tree_nets),
("window", args.window_reroute is not None),
("vias", args.reduce_vias is not None),
("via_cost", args.via_cost is not None),
) )
if asked if asked
] ]
@@ -227,7 +340,7 @@ def main(argv: list[str] | None = None) -> int:
with open(dsn_path, encoding="utf-8") as f: with open(dsn_path, encoding="utf-8") as f:
dsn_text = f.read() dsn_text = f.read()
except OSError as e: except OSError as e:
print(f"freeroute: cannot read {dsn_path}: {e}", file=sys.stderr) print(f"rpmroute: cannot read {dsn_path}: {e}", file=sys.stderr)
return 2 return 2
dsn = parse_dsn(dsn_text) dsn = parse_dsn(dsn_text)
@@ -247,9 +360,21 @@ def main(argv: list[str] | None = None) -> int:
"resolution": 2 if args.grid_resolution is None else args.grid_resolution, "resolution": 2 if args.grid_resolution is None else args.grid_resolution,
"heuristic_weight": args.heuristic_weight, "heuristic_weight": args.heuristic_weight,
"access_cost": args.access_cost or 0.0, "access_cost": args.access_cost or 0.0,
"negotiate": args.negotiate or 0,
"hole_to_hole_mm": args.hole_to_hole, "hole_to_hole_mm": args.hole_to_hole,
"rollback": args.rollback, "rollback": args.rollback,
"tree_nets": args.tree_nets,
"window_reroute": args.window_reroute or 0,
"window_resolution": args.window_resolution,
"window_margin_mm": args.window_margin,
"window_budget": args.window_budget,
"window_cap": args.window_cap,
"reduce_vias": bool(args.reduce_vias),
"reduce_vias_budget": args.reduce_vias_budget,
"reduce_vias_margin_mm": args.reduce_vias_margin,
} }
if args.via_cost is not None:
options["via_cost"] = args.via_cost
elif args.engine == "grid": elif args.engine == "grid":
options = { options = {
"layers": layers, "layers": layers,
@@ -258,9 +383,13 @@ def main(argv: list[str] | None = None) -> int:
"edge_clearance_mm": args.edge_clearance, "edge_clearance_mm": args.edge_clearance,
"resolution": 1 if args.grid_resolution is None else args.grid_resolution, "resolution": 1 if args.grid_resolution is None else args.grid_resolution,
"access_cost": args.access_cost or 0.0, "access_cost": args.access_cost or 0.0,
"negotiate": args.negotiate or 0,
"hole_to_hole_mm": args.hole_to_hole, "hole_to_hole_mm": args.hole_to_hole,
"rollback": args.rollback, "rollback": args.rollback,
"tree_nets": args.tree_nets,
} }
if args.via_cost is not None:
options["via_cost"] = args.via_cost
if args.engine == "room": if args.engine == "room":
result = build_rooms_routing_result( result = build_rooms_routing_result(
dsn, layers=layers, shove=args.shove, pack=args.pack, dsn, layers=layers, shove=args.shove, pack=args.pack,
@@ -273,14 +402,14 @@ def main(argv: list[str] | None = None) -> int:
dsn_text, args.engine, options, rounds=args.promote_failures, seed=args.seed dsn_text, args.engine, options, rounds=args.promote_failures, seed=args.seed
) )
counts = ", ".join(str(m) for m, _z in rounds) counts = ", ".join(str(m) for m, _z in rounds)
print(f"freeroute: {len(rounds)} rounds, unrouted {counts}; kept the best", file=sys.stderr) print(f"rpmroute: {len(rounds)} rounds, unrouted {counts}; kept the best", file=sys.stderr)
elif args.orders and args.orders > 1: elif args.orders and args.orders > 1:
result, kept, tried = best_of_orders( result, kept, tried = best_of_orders(
dsn_text, args.engine, options, orders=args.orders, seed=args.seed, jobs=args.jobs dsn_text, args.engine, options, orders=args.orders, seed=args.seed, jobs=args.jobs
) )
counts = ", ".join(f"{'default' if s is None else s}: {m}" for s, (m, _z) in tried) counts = ", ".join(f"{'default' if s is None else s}: {m}" for s, (m, _z) in tried)
print( print(
f"freeroute: tried {len(tried)} orders, kept " f"rpmroute: tried {len(tried)} orders, kept "
f"{'the default order' if kept is None else f'--seed {kept}'} (unrouted {counts})", f"{'the default order' if kept is None else f'--seed {kept}'} (unrouted {counts})",
file=sys.stderr, file=sys.stderr,
) )
@@ -294,12 +423,12 @@ def main(argv: list[str] | None = None) -> int:
in_zone = [u for u in result.unrouted if u[3]] in_zone = [u for u in result.unrouted if u[3]]
if missing: if missing:
# the SES is still written; say plainly what it is missing # the SES is still written; say plainly what it is missing
print(f"freeroute: {len(missing)} connection(s) not routed:", file=sys.stderr) print(f"rpmroute: {len(missing)} connection(s) not routed:", file=sys.stderr)
for net, a, b, _zone in missing: for net, a, b, _zone in missing:
print(f" {net}: {a} to {b}", file=sys.stderr) print(f" {net}: {a} to {b}", file=sys.stderr)
if result.narrowed: if result.narrowed:
print( print(
f"freeroute: {len(result.narrowed)} connection(s) of a wider net class only fitted " f"rpmroute: {len(result.narrowed)} connection(s) of a wider net class only fitted "
"at the default width; their nets are written at the default width:", "at the default width; their nets are written at the default width:",
file=sys.stderr, file=sys.stderr,
) )
@@ -307,18 +436,40 @@ def main(argv: list[str] | None = None) -> int:
print(f" {net}: {a} to {b}", file=sys.stderr) print(f" {net}: {a} to {b}", file=sys.stderr)
if in_zone: if in_zone:
print( print(
f"freeroute: {len(in_zone)} more connection(s) left to a zone fill that may join them:", f"rpmroute: {len(in_zone)} more connection(s) left to a zone fill that may join them:",
file=sys.stderr, file=sys.stderr,
) )
for net, a, b, zone in in_zone: for net, a, b, zone in in_zone:
print(f" {net}: {a} to {b} (both in zone {zone})", file=sys.stderr) print(f" {net}: {a} to {b} (both in zone {zone})", file=sys.stderr)
flawed = False
if args.engine != "exact":
# These engines route on approximations and do not check the copper
# they write: check it now against the exact shapes the exact engine
# uses, so shorts are reported rather than shipped.
check = verify_result(dsn, result)
flawed = not check.clean
print(
f"rpmroute: {args.engine} output checked on exact shapes: "
f"{check.shorts} short(s), {check.clearance} clearance violation(s)",
file=sys.stderr,
)
for kind, examples in (("short", check.short_examples), ("clearance", check.clearance_examples)):
for found in examples:
print(f" {kind}: {found}", file=sys.stderr)
if flawed:
print(
f"rpmroute: WARNING: this {args.engine} routing is not DRC-clean; fix it in "
"KiCad or route with --engine exact (the default)",
file=sys.stderr,
)
if args.output: if args.output:
with open(args.output, "w", encoding="utf-8") as f: with open(args.output, "w", encoding="utf-8") as f:
f.write(ses_text) f.write(ses_text)
else: else:
sys.stdout.write(ses_text) sys.stdout.write(ses_text)
return 0 return 3 if (flawed and args.strict) else 0
if __name__ == "__main__": if __name__ == "__main__":
@@ -1,13 +1,13 @@
"""Specctra DSN parsing for freeroute. """Specctra DSN parsing for rpmroute.
Public API:: Public API::
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
board = parse_dsn(dsn_text) board = parse_dsn(dsn_text)
``parse_dsn`` returns a typed :class:`~freeroute.dsn.model.DsnBoard`. The ``parse_dsn`` returns a typed :class:`~rpmroute.dsn.model.DsnBoard`. The
lower-level :func:`~freeroute.dsn.tokenizer.tokenize` and lower-level :func:`~rpmroute.dsn.tokenizer.tokenize` and
:func:`~freeroute.dsn.sexp.parse` are exposed for tooling and tests. :func:`~rpmroute.dsn.sexp.parse` are exposed for tooling and tests.
""" """
from __future__ import annotations from __future__ import annotations
@@ -22,7 +22,7 @@ class SExp:
``head`` is the text of the first token when it is an atom (e.g. ``pcb``, ``head`` is the text of the first token when it is an atom (e.g. ``pcb``,
``layer``, ``net``), else ``None``. ``items`` holds the remaining elements, ``layer``, ``net``), else ``None``. ``items`` holds the remaining elements,
each either a :class:`~freeroute.dsn.tokenizer.Token` (a leaf atom/string) each either a :class:`~rpmroute.dsn.tokenizer.Token` (a leaf atom/string)
or a nested :class:`SExp`. or a nested :class:`SExp`.
""" """
@@ -1,4 +1,4 @@
"""Planar geometry primitives for freeroute. """Planar geometry primitives for rpmroute.
A port of the subset of FreeRouting's ``geometry/planar`` package the router A port of the subset of FreeRouting's ``geometry/planar`` package the router
needs, with the exact-arithmetic types preserved. Arithmetic model per type: needs, with the exact-arithmetic types preserved. Arithmetic model per type:
@@ -21,7 +21,7 @@ from .direction import Direction, IntDirection
from .float_point import FloatPoint from .float_point import FloatPoint
from .limits import CRIT_DOUBLE, CRIT_INT from .limits import CRIT_DOUBLE, CRIT_INT
from .line import Line from .line import Line
from .octagon import ceil_sqrt2, overlaps_2d, segment_octagon from .octagon import ceil_sqrt2, overlaps_2d, segment_octagon, segment_slab
from .point import IntPoint, Point, RationalPoint, point, rational_point from .point import IntPoint, Point, RationalPoint, point, rational_point
from .polygon import Polygon from .polygon import Polygon
from .polygon_shape import PolygonShape from .polygon_shape import PolygonShape
@@ -59,5 +59,6 @@ __all__ = [
"shove_segment", "shove_segment",
"ceil_sqrt2", "ceil_sqrt2",
"segment_octagon", "segment_octagon",
"segment_slab",
"overlaps_2d", "overlaps_2d",
] ]
@@ -231,7 +231,7 @@ class IntBox:
return [FloatPoint(c.x, c.y) for c in self.corners()] return [FloatPoint(c.x, c.y) for c in self.corners()]
def to_simplex(self): def to_simplex(self):
"""Return this box as a :class:`~freeroute.geometry.simplex.Simplex`. """Return this box as a :class:`~rpmroute.geometry.simplex.Simplex`.
Four directed border lines whose common right side is the box interior Four directed border lines whose common right side is the box interior
(ports ``IntBox.to_Simplex``). (ports ``IntBox.to_Simplex``).
@@ -6,7 +6,7 @@ Ports ``geometry/planar/FloatPoint.java``.
keeps ``FloatPoint`` *outside* the exact ``Point`` hierarchy because float math keeps ``FloatPoint`` *outside* the exact ``Point`` hierarchy because float math
is inexact; it is used for distances, rounding, and speed-over-accuracy paths. is inexact; it is used for distances, rounding, and speed-over-accuracy paths.
Its :meth:`side_of` has no reliable ``COLLINEAR`` result (numerical noise), so Its :meth:`side_of` has no reliable ``COLLINEAR`` result (numerical noise), so
exact side tests must go through :class:`~freeroute.geometry.point.Point`. exact side tests must go through :class:`~rpmroute.geometry.point.Point`.
""" """
from __future__ import annotations from __future__ import annotations
@@ -137,13 +137,13 @@ class FloatPoint:
# --- rounding to integer points ---------------------------------------- # --- rounding to integer points ----------------------------------------
def round(self): def round(self):
"""Round to the nearest :class:`~freeroute.geometry.point.IntPoint`.""" """Round to the nearest :class:`~rpmroute.geometry.point.IntPoint`."""
from .point import IntPoint from .point import IntPoint
return IntPoint(_round_half_up(self.x), _round_half_up(self.y)) return IntPoint(_round_half_up(self.x), _round_half_up(self.y))
def bounding_box(self): def bounding_box(self):
"""Smallest :class:`~freeroute.geometry.box.IntBox` containing this point.""" """Smallest :class:`~rpmroute.geometry.box.IntBox` containing this point."""
from .box import IntBox from .box import IntBox
return IntBox( return IntBox(
@@ -2,12 +2,12 @@
Ports ``geometry/planar/Line.java`` (the subset needed for the router's Ports ``geometry/planar/Line.java`` (the subset needed for the router's
half-plane work). Like the upstream class, a ``Line`` is defined by two half-plane work). Like the upstream class, a ``Line`` is defined by two
:class:`~freeroute.geometry.point.IntPoint` endpoints. :class:`~rpmroute.geometry.point.IntPoint` endpoints.
**Arithmetic model: exact.** :meth:`side_of` uses an exact integer determinant, **Arithmetic model: exact.** :meth:`side_of` uses an exact integer determinant,
and :meth:`intersection` returns an :class:`~freeroute.geometry.point.IntPoint` and :meth:`intersection` returns an :class:`~rpmroute.geometry.point.IntPoint`
when the crossing is integral and a when the crossing is integral and a
:class:`~freeroute.geometry.point.RationalPoint` otherwise (``z == 0`` when the :class:`~rpmroute.geometry.point.RationalPoint` otherwise (``z == 0`` when the
lines are parallel — the "point at infinity"). :meth:`intersection_approx` is lines are parallel — the "point at infinity"). :meth:`intersection_approx` is
the fast ``float`` path. the fast ``float`` path.
""" """
@@ -29,7 +29,7 @@ from .line import Line
from .point import IntPoint from .point import IntPoint
from .simplex import Simplex from .simplex import Simplex
__all__ = ["ceil_sqrt2", "segment_octagon", "overlaps_2d"] __all__ = ["ceil_sqrt2", "segment_octagon", "segment_slab", "overlaps_2d"]
def ceil_sqrt2(radius: int) -> int: def ceil_sqrt2(radius: int) -> int:
@@ -82,6 +82,46 @@ def segment_octagon(a: IntPoint, b: IntPoint, radius: int) -> Simplex:
return Simplex.get_instance(lines) return Simplex.get_instance(lines)
def segment_slab(a: IntPoint, b: IntPoint, radius: int) -> Simplex:
"""Convex cover of segment ``a``-``b`` swept by ``radius``, at any angle.
The rectangle along the segment, ``radius`` either side, with flush ends
like :func:`polyline.segment_box`: the ends of a trace leg sit on a pad or
on the square corner tile of the next leg, which cover them. Corners are
rounded away from the middle and the radius gets one unit more, so the
side bounds never under-report, and it stays tight for a slanted segment
off the 45-degree lines (a pin leaving along its pad's axis on a part
turned 30 degrees).
"""
dx, dy = b.x - a.x, b.y - a.y
length = math.hypot(dx, dy)
r = max(radius, 0) + 1
if length == 0:
return Simplex.from_corners([
IntPoint(a.x - r, a.y - r), IntPoint(a.x + r, a.y - r),
IntPoint(a.x + r, a.y + r), IntPoint(a.x - r, a.y + r),
])
ux, uy = dx / length, dy / length
nx, ny = -uy, ux
mx, my = (a.x + b.x) / 2, (a.y + b.y) / 2
def out(x: float, y: float) -> IntPoint:
return IntPoint(math.ceil(x) if x >= mx else math.floor(x),
math.ceil(y) if y >= my else math.floor(y))
corners = [
out(a.x + nx * r, a.y + ny * r),
out(b.x + nx * r, b.y + ny * r),
out(b.x - nx * r, b.y - ny * r),
out(a.x - nx * r, a.y - ny * r),
]
for winding in (corners, corners[::-1]):
slab = Simplex.from_corners(winding)
if not slab.is_empty():
return slab
return Simplex(())
def overlaps_2d(shape_a, shape_b) -> bool: def overlaps_2d(shape_a, shape_b) -> bool:
"""True if the two convex tiles share 2-D area (a real clearance overlap). """True if the two convex tiles share 2-D area (a real clearance overlap).
@@ -1,7 +1,7 @@
"""``Polygon`` — a normalized corner list (no duplicate or collinear corners). """``Polygon`` — a normalized corner list (no duplicate or collinear corners).
Ports ``geometry/planar/Polygon.java``. Used as the corner normalizer behind Ports ``geometry/planar/Polygon.java``. Used as the corner normalizer behind
:class:`~freeroute.geometry.polygon_shape.PolygonShape`. :class:`~rpmroute.geometry.polygon_shape.PolygonShape`.
**Arithmetic model:** corner de-duplication and collinearity removal are **Arithmetic model:** corner de-duplication and collinearity removal are
**exact** (exact ``Point.side_of``); the winding-number test is approximate **exact** (exact ``Point.side_of``); the winding-number test is approximate
@@ -2,7 +2,7 @@
Ports ``geometry/planar/PolygonShape.java``, in particular the recursive Ports ``geometry/planar/PolygonShape.java``, in particular the recursive
``split_to_convex`` that decomposes a simple polygon into convex ``split_to_convex`` that decomposes a simple polygon into convex
:class:`~freeroute.geometry.simplex.Simplex` tiles — the decomposition the :class:`~rpmroute.geometry.simplex.Simplex` tiles — the decomposition the
router's search tree relies on. router's search tree relies on.
**Arithmetic model:** corner orientation / convexity tests are **exact** **Arithmetic model:** corner orientation / convexity tests are **exact**
@@ -7,7 +7,7 @@ trace half-width — the copper region — as a set of exact convex tiles.
**Arithmetic model: exact, integer.** The router that uses this routes **Arithmetic model: exact, integer.** The router that uses this routes
*orthogonally* (axis-aligned segments), so each swept segment is an exact *orthogonally* (axis-aligned segments), so each swept segment is an exact
:class:`~freeroute.geometry.box.IntBox` (centreline offset by the half-width, :class:`~rpmroute.geometry.box.IntBox` (centreline offset by the half-width,
squared at the ends). The 45-degree case (which needs ``IntOctagon`` caps to squared at the ends). The 45-degree case (which needs ``IntOctagon`` caps to
stay exact) is deferred; ``segment_box`` returns the axis-aligned bounding box stay exact) is deferred; ``segment_box`` returns the axis-aligned bounding box
for a diagonal segment, which is a *conservative* cover (it never under-reports for a diagonal segment, which is a *conservative* cover (it never under-reports
@@ -1,10 +1,10 @@
"""``Simplex`` — a convex region as the intersection of directed half-planes. """``Simplex`` — a convex region as the intersection of directed half-planes.
Ports ``geometry/planar/Simplex.java``. A simplex is defined by an array of Ports ``geometry/planar/Simplex.java``. A simplex is defined by an array of
directed :class:`~freeroute.geometry.line.Line`s sorted by direction angle; the directed :class:`~rpmroute.geometry.line.Line`s sorted by direction angle; the
region is the intersection of the *right* half-plane of each line. Corners are region is the intersection of the *right* half-plane of each line. Corners are
the exact intersections of consecutive border lines the exact intersections of consecutive border lines
(:meth:`~freeroute.geometry.line.Line.intersection`). (:meth:`~rpmroute.geometry.line.Line.intersection`).
**Arithmetic model: exact where it matters.** Corners and all point-containment **Arithmetic model: exact where it matters.** Corners and all point-containment
tests are exact (exact line intersection + exact ``side_of``). ``offset`` is tests are exact (exact line intersection + exact ``side_of``). ``offset`` is
@@ -3,11 +3,11 @@
Ports the concrete (non-abstract) behaviour of ``geometry/planar/TileShape.java`` Ports the concrete (non-abstract) behaviour of ``geometry/planar/TileShape.java``
that is defined purely in terms of the border lines and corners: point that is defined purely in terms of the border lines and corners: point
containment, area, centre of gravity, and border tests. Concrete subclasses containment, area, centre of gravity, and border tests. Concrete subclasses
(:class:`~freeroute.geometry.simplex.Simplex`) supply ``border_line_count``, (:class:`~rpmroute.geometry.simplex.Simplex`) supply ``border_line_count``,
``border_line``, ``corner`` and ``corner_approx``. ``border_line``, ``corner`` and ``corner_approx``.
**Arithmetic model:** containment and ``contains_on_border`` are **exact** **Arithmetic model:** containment and ``contains_on_border`` are **exact**
(they use the exact :meth:`~freeroute.geometry.line.Line.side_of`); ``area`` and (they use the exact :meth:`~rpmroute.geometry.line.Line.side_of`); ``area`` and
``centre_of_gravity`` are approximate (``float``), as upstream. ``centre_of_gravity`` are approximate (``float``), as upstream.
A convex tile is the intersection of the right half-planes of its directed A convex tile is the intersection of the right half-planes of its directed
@@ -13,7 +13,7 @@ Ports ``geometry/planar/{Vector,IntVector,RationalVector}.java``.
representing the affine vector ``(x/z, y/z)``; ``z`` is kept non-negative. representing the affine vector ``(x/z, y/z)``; ``z`` is kept non-negative.
Mirrors the upstream ``BigInteger`` triple. ``BigIntDirection`` is not needed Mirrors the upstream ``BigInteger`` triple. ``BigIntDirection`` is not needed
because ``int`` is unbounded, so normalized directions are always because ``int`` is unbounded, so normalized directions are always
:class:`~freeroute.geometry.direction.IntDirection`. :class:`~rpmroute.geometry.direction.IntDirection`.
""" """
from __future__ import annotations from __future__ import annotations
@@ -1,9 +1,9 @@
"""Autorouting for freeroute. """Autorouting for rpmroute.
An MVP grid-based maze router and the DSN-in / SES-out pipeline that makes An MVP grid-based maze router and the DSN-in / SES-out pipeline that makes
freeroute a Java-free replacement for the ``freerouting.jar`` step:: rpmroute a Java-free replacement for the ``freerouting.jar`` step::
from freeroute.route import route from rpmroute.route import route
ses_text = route(dsn_text) ses_text = route(dsn_text)
The router (:class:`GridRouter`) is intentionally simple — single-layer A* over The router (:class:`GridRouter`) is intentionally simple — single-layer A* over
@@ -1,18 +1,18 @@
"""Exact-geometry routing track (orthogonal), built on the search tree. """Exact-geometry routing track (orthogonal), built on the search tree.
The grid MVP (:mod:`freeroute.route.grid_router`) approximates clearance with The grid MVP (:mod:`rpmroute.route.grid_router`) approximates clearance with
cell occupancy and emits centrelines with no width-aware DRC check. This track cell occupancy and emits centrelines with no width-aware DRC check. This track
keeps the grid's rip-up/multi-layer/via *topology* search (in orthogonal mode, keeps the grid's rip-up/multi-layer/via *topology* search (in orthogonal mode,
so segments are axis-aligned) but replaces the occupancy check with an **exact** so segments are axis-aligned) but replaces the occupancy check with an **exact**
one: every item's copper is an exact :class:`~freeroute.geometry.IntBox` tile one: every item's copper is an exact :class:`~rpmroute.geometry.IntBox` tile
indexed in a :class:`~freeroute.board.search_tree.ShapeSearchTree`, and the indexed in a :class:`~rpmroute.board.search_tree.ShapeSearchTree`, and the
routed board is verified to have **no clearance violation** by exact tile routed board is verified to have **no clearance violation** by exact tile
intersection. A net whose copper would violate is dropped, so the output is intersection. A net whose copper would violate is dropped, so the output is
DRC-clean by construction. DRC-clean by construction.
**Shove (opt-in, ``shove=True``).** Before a dropped net is abandoned, the **Shove (opt-in, ``shove=True``).** Before a dropped net is abandoned, the
router tries to make room by *moving an existing trace aside* geometrically router tries to make room by *moving an existing trace aside* geometrically
(:func:`~freeroute.geometry.shove_segment`) rather than dropping the incoming (:func:`~rpmroute.geometry.shove_segment`) rather than dropping the incoming
net. A shove is accepted only if the moved trace still connects its pads, clears net. A shove is accepted only if the moved trace still connects its pads, clears
every other item exactly (via the tree), and stays in the board outline — so every other item exactly (via the tree), and stays in the board outline — so
cleanliness is preserved. Shoves are bounded (``max_shove_depth`` and a cleanliness is preserved. Shoves are bounded (``max_shove_depth`` and a
@@ -30,10 +30,10 @@ from __future__ import annotations
from dataclasses import dataclass, field from dataclasses import dataclass, field
import math import math
from freeroute.board.board import BasicBoard from rpmroute.board.board import BasicBoard
from freeroute.board.items import Pin, Via from rpmroute.board.items import Pin, Via
from freeroute.board.search_tree import ShapeSearchTree, TreeShape from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.geometry import ( from rpmroute.geometry import (
IntBox, IntBox,
IntPoint, IntPoint,
Polyline, Polyline,
@@ -41,9 +41,10 @@ from freeroute.geometry import (
Simplex, Simplex,
segment_box, segment_box,
segment_octagon, segment_octagon,
segment_slab,
shove_segment, shove_segment,
) )
from freeroute.geometry.polyline import corner_box from rpmroute.geometry.polyline import corner_box
from .grid_router import RouteResult, route_board from .grid_router import RouteResult, route_board
@@ -99,10 +100,14 @@ def route_board_exact(
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
rollback: bool = True, rollback: bool = True,
tree_nets: bool = True,
net_widths: dict[int, int] | None = None, net_widths: dict[int, int] | None = None,
via_drill: int | None = None, via_drill: int | None = None,
hole_to_hole: int = 0, hole_to_hole: int = 0,
only_nets: frozenset | None = None,
bounds: IntBox | None = None,
) -> ExactRouteResult: ) -> ExactRouteResult:
"""Route ``board`` orthogonally and verify the result with exact geometry. """Route ``board`` orthogonally and verify the result with exact geometry.
@@ -134,10 +139,14 @@ def route_board_exact(
seed=seed, seed=seed,
route_first=route_first, route_first=route_first,
access_cost=access_cost, access_cost=access_cost,
negotiate=negotiate,
rollback=rollback, rollback=rollback,
tree_nets=tree_nets,
net_widths=net_widths, net_widths=net_widths,
via_drill=via_drill, via_drill=via_drill,
hole_to_hole=hole_to_hole, hole_to_hole=hole_to_hole,
only_nets=only_nets,
bounds=bounds,
) )
edge = 0 if edge_clearance is None else edge_clearance edge = 0 if edge_clearance is None else edge_clearance
outline = board.outline outline = board.outline
@@ -146,6 +155,148 @@ def route_board_exact(
owner = _counter() owner = _counter()
# static items: pad and keepout copper (routed=False) # static items: pad and keepout copper (routed=False)
insert_static_copper(tree, board, signal_layers, owner)
via_layers = frozenset(signal_layers)
accepted: dict[int, _Accepted] = {}
fixed_vias = {
(item.net_nos[0], item.location)
for item in board.get_items()
if isinstance(item, Via) and item.fixed and item.net_nos
}
# Verify connection by connection, so one conflicting segment of a
# 25-pin supply net costs that one connection, not the whole net.
rejected: list[tuple[int, str, str]] = []
ends_list = result.connection_ends or [("?", "?", "")] * len(result.connections)
anchors_list = getattr(result, "connection_anchors", None) or [()] * len(result.connections)
# each net is checked at the width it will be written at: its class's
# when all of its connections went in at that, else the default
net_half = dict(result.net_half)
# a connection that ended on another's copper (a T into its net's tree)
# dangles if that one is dropped, so it is dropped too; connections come
# in commit order, anchors first
dropped_at: set[int] = set()
for pos, ((net_no, wires, vias), ends, anchors) in sorted(
enumerate(zip(result.connections, ends_list, anchors_list, strict=False)),
key=lambda c: c[1][0][0],
):
if any(a in dropped_at for a in anchors):
dropped_at.add(pos)
rejected.append((net_no, *ends))
continue
wire_half = net_half.get(net_no, half_width)
pieces = _copper_pieces(wires, vias, wire_half, via_layers, via_half)
boxes = [(box, box_layers) for box, box_layers, _ in pieces]
wire_count = len(_copper_pieces(wires, [], wire_half, via_layers, via_half))
if any(
(
tree.segment_conflict(*seg, wire_half, net_no, layer, clearance)
if seg is not None
else tree.clearance_conflict(
box, net_no, layer, clearance, "wire" if i < wire_count else "via"
)
)
for i, (box, box_layers, seg) in enumerate(pieces)
for layer in box_layers
) or _end_in_rule_area(tree, wires, wire_half) or (
outline is not None and not _inside_outline(
outline, boxes[:wire_count], vias, (via_half or wire_half) + edge, edge
)
):
rejected.append((net_no, *ends))
dropped_at.add(pos)
continue # exact-clearance conflict -> drop (may be recovered by shove)
acc = accepted.get(net_no)
if acc is None:
acc = accepted[net_no] = _Accepted(wires=[], vias=[])
acc.wires.extend(wires)
# connections of one net that end on the same plane cell share its
# via: write it once, and never on top of a via already on the board
acc.vias.extend(
v for v in dict.fromkeys(vias)
if v not in acc.vias and not _on_fixed_via(net_no, v, fixed_vias, via_half)
)
for box, box_layers, seg in pieces:
oid = next(owner)
if seg is None:
tree.insert(TreeShape(oid, net_no, box_layers, box, routed=True))
else: # a slanted pin exit: its exact copper, rebuilt for the DRC check
tree.insert(TreeShape(
oid, net_no, box_layers, box, routed=True,
exact=segment_slab(*seg, wire_half), seg=("slab", *seg, wire_half),
))
acc.owners.append(oid)
accepted_before_recovery = set(accepted)
# a net is dropped if it has a real ratsnest (>= 2 pins on a signal layer)
# but was not accepted — whether the grid failed to route it or its exact
# copper conflicted.
routable = _routable_nets(board, signal_layers)
if only_nets is not None: # a window re-route: the other nets are not ours to route
routable &= set(only_nets)
dropped = sorted(routable - set(accepted))
shoves = 0
if shove and dropped:
outline = board.bounding_box
for net_no in dropped:
done = _shove_recover(
net_no,
board,
tree,
accepted,
owner,
signal_layers,
half_width,
clearance,
step,
outline,
max_shove_depth,
shove_cap,
)
if done:
shoves += done
if diagonal:
outline = board.bounding_box
for net_no in sorted(routable):
_diagonalize(
net_no, board, tree, accepted, owner, signal_layers, half_width, clearance, outline
)
clean = RouteResult(half_width)
# what is still missing: what the grid could not route, plus what the
# exact check rejected, less any net shove or the diagonal pass recovered
clean.failed = [
*result.failed,
*(r for r in rejected if not (r[0] in accepted and r[0] not in accepted_before_recovery)),
]
for net_no, acc in accepted.items():
clean.wires[net_no] = acc.wires
clean.vias[net_no] = acc.vias
# shove and the diagonal pass lay copper at the default width: nets they
# recovered, and nets whose traces shove pushed aside
reshaped = (set(accepted) - accepted_before_recovery) | {
net for net, acc in accepted.items() if acc.shove_count
}
if diagonal:
reshaped = set(accepted)
clean.net_half = {
net: half for net, half in net_half.items() if net in accepted and net not in reshaped
}
clean.narrowed = list(result.narrowed)
drc_clean = tree.has_violation(clearance) is None
return ExactRouteResult(result=clean, tree=tree, drc_clean=drc_clean, shoves=shoves)
# --- 45-degree (diagonal) recovery -------------------------------------------
def insert_static_copper(tree: ShapeSearchTree, board: BasicBoard, signal_layers, owner) -> None:
"""Index the board's pads, fixed copper and keepouts (``routed=False``) on
``signal_layers``: what routed copper is checked against."""
for pin in board.get_pins(): for pin in board.get_pins():
if pin.shape is None: if pin.shape is None:
continue continue
@@ -179,115 +330,6 @@ def route_board_exact(
) )
) )
via_layers = frozenset(signal_layers)
accepted: dict[int, _Accepted] = {}
fixed_vias = {
(item.net_nos[0], item.location)
for item in board.get_items()
if isinstance(item, Via) and item.fixed and item.net_nos
}
# Verify connection by connection, so one conflicting segment of a
# 25-pin supply net costs that one connection, not the whole net.
rejected: list[tuple[int, str, str]] = []
ends_list = result.connection_ends or [("?", "?", "")] * len(result.connections)
# each net is checked at the width it will be written at: its class's
# when all of its connections went in at that, else the default
net_half = dict(result.net_half)
for (net_no, wires, vias), ends in sorted(
zip(result.connections, ends_list, strict=False), key=lambda c: c[0][0]
):
wire_half = net_half.get(net_no, half_width)
boxes = _copper_boxes(wires, vias, wire_half, via_layers, via_half)
wire_count = len(_copper_boxes(wires, [], wire_half, via_layers, via_half))
if any(
tree.clearance_conflict(
box, net_no, layer, clearance, "wire" if i < wire_count else "via"
)
for i, (box, box_layers) in enumerate(boxes)
for layer in box_layers
) or _end_in_rule_area(tree, wires, wire_half) or (
outline is not None and not all(outline.box_clear(b, edge) for b, _ in boxes)
):
rejected.append((net_no, *ends))
continue # exact-clearance conflict -> drop (may be recovered by shove)
acc = accepted.get(net_no)
if acc is None:
acc = accepted[net_no] = _Accepted(wires=[], vias=[])
acc.wires.extend(wires)
# connections of one net that end on the same plane cell share its
# via: write it once, and never on top of a via already on the board
acc.vias.extend(
v for v in dict.fromkeys(vias)
if v not in acc.vias and not _on_fixed_via(net_no, v, fixed_vias, via_half)
)
for box, box_layers in boxes:
oid = next(owner)
tree.insert(TreeShape(oid, net_no, box_layers, box, routed=True))
acc.owners.append(oid)
accepted_before_recovery = set(accepted)
# a net is dropped if it has a real ratsnest (>= 2 pins on a signal layer)
# but was not accepted — whether the grid failed to route it or its exact
# copper conflicted.
dropped = sorted(_routable_nets(board, signal_layers) - set(accepted))
shoves = 0
if shove and dropped:
outline = board.bounding_box
for net_no in dropped:
done = _shove_recover(
net_no,
board,
tree,
accepted,
owner,
signal_layers,
half_width,
clearance,
step,
outline,
max_shove_depth,
shove_cap,
)
if done:
shoves += done
if diagonal:
outline = board.bounding_box
for net_no in sorted(_routable_nets(board, signal_layers)):
_diagonalize(
net_no, board, tree, accepted, owner, signal_layers, half_width, clearance, outline
)
clean = RouteResult(half_width)
# what is still missing: what the grid could not route, plus what the
# exact check rejected, less any net shove or the diagonal pass recovered
clean.failed = [
*result.failed,
*(r for r in rejected if not (r[0] in accepted and r[0] not in accepted_before_recovery)),
]
for net_no, acc in accepted.items():
clean.wires[net_no] = acc.wires
clean.vias[net_no] = acc.vias
# shove and the diagonal pass lay copper at the default width: nets they
# recovered, and nets whose traces shove pushed aside
reshaped = (set(accepted) - accepted_before_recovery) | {
net for net, acc in accepted.items() if acc.shove_count
}
if diagonal:
reshaped = set(accepted)
clean.net_half = {
net: half for net, half in net_half.items() if net in accepted and net not in reshaped
}
clean.narrowed = list(result.narrowed)
drc_clean = tree.has_violation(clearance) is None
return ExactRouteResult(result=clean, tree=tree, drc_clean=drc_clean, shoves=shoves)
# --- 45-degree (diagonal) recovery -------------------------------------------
def _octilinear_candidates(a: IntPoint, b: IntPoint) -> list[list[IntPoint]]: def _octilinear_candidates(a: IntPoint, b: IntPoint) -> list[list[IntPoint]]:
"""Octilinear (0/45/90/135-degree) polylines from ``a`` to ``b``. """Octilinear (0/45/90/135-degree) polylines from ``a`` to ``b``.
@@ -597,7 +639,7 @@ def _conflicting_segment(corners, d_boxes, half_width, clearance):
horizontal = a.y == b.y horizontal = a.y == b.y
if not horizontal and a.x != b.x: if not horizontal and a.x != b.x:
continue # skip diagonal grid stubs continue # skip diagonal grid stubs
from freeroute.geometry import segment_box from rpmroute.geometry import segment_box
seg = segment_box(a, b, half_width).offset(clearance) seg = segment_box(a, b, half_width).offset(clearance)
if any(seg.overlaps(box) for box in d_boxes): if any(seg.overlaps(box) for box in d_boxes):
@@ -658,6 +700,27 @@ def _on_fixed_via(net_no, point, fixed_vias, via_half) -> bool:
) )
def _copper_pieces(wires, vias, half_width, via_layers, via_half=None):
"""Like :func:`_copper_boxes`, but a slanted wire segment (a pin leaving
along a turned pad's axis) comes with its end points, so it can be checked
on its exact copper: ``(box, layers, (a, b) or None)``."""
via_half = via_half or half_width
pieces: list[tuple[IntBox, frozenset[int], tuple | None]] = []
for layer, points in wires:
on = frozenset({layer})
for a, b in zip(points, points[1:], strict=False):
if a.x == b.x or a.y == b.y:
pieces.append((segment_box(a, b, half_width), on, None))
else:
pieces.append((segment_slab(a, b, half_width).bounding_box(), on, (a, b)))
for c in points[1:-1]:
pieces.append((corner_box(c, half_width), on, None))
for loc in vias:
vbox = IntBox(loc.x - via_half, loc.y - via_half, loc.x + via_half, loc.y + via_half)
pieces.append((vbox, via_layers, None))
return pieces
def _copper_boxes(wires, vias, half_width, via_layers, via_half=None): def _copper_boxes(wires, vias, half_width, via_layers, via_half=None):
via_half = via_half or half_width via_half = via_half or half_width
boxes: list[tuple[IntBox, frozenset[int]]] = [] boxes: list[tuple[IntBox, frozenset[int]]] = []
@@ -670,6 +733,15 @@ def _copper_boxes(wires, vias, half_width, via_layers, via_half=None):
return boxes return boxes
def _inside_outline(outline, wire_boxes, vias, via_reach, edge) -> bool:
"""Copper inside the board, ``edge`` from its outline. A via is round, as
the grid and KiCad take it: its square box would reach past a chamfered
corner where the via itself does not."""
return all(outline.box_clear(b, edge) for b, _ in wire_boxes) and all(
outline.point_clear(v, via_reach) for v in vias
)
def _is_rotated(shape) -> bool: def _is_rotated(shape) -> bool:
return isinstance(shape, Simplex) and not shape.is_int_box() return isinstance(shape, Simplex) and not shape.is_int_box()
@@ -31,11 +31,11 @@ import itertools
import math import math
import random import random
from freeroute.board.board import BasicBoard from rpmroute.board.board import BasicBoard
from freeroute.board.items import ConductionArea, ObstacleArea, Pin, Via from rpmroute.board.items import ConductionArea, ObstacleArea, Pin, Via
from freeroute.geometry import IntBox, IntPoint, Simplex from rpmroute.geometry import IntBox, IntPoint, Simplex
from freeroute.geometry.octagon import overlaps_2d from rpmroute.geometry.octagon import overlaps_2d, segment_slab
from freeroute.geometry.polyline import corner_box from rpmroute.geometry.polyline import corner_box, segment_box
__all__ = ["GridRouter", "RouteResult", "route_board"] __all__ = ["GridRouter", "RouteResult", "route_board"]
@@ -65,7 +65,7 @@ class RouteResult:
__slots__ = ( __slots__ = (
"wires", "vias", "half_width", "unrouted", "connections", "connection_ends", "failed", "wires", "vias", "half_width", "unrouted", "connections", "connection_ends", "failed",
"net_half", "narrowed", "net_half", "narrowed", "connection_anchors",
) )
def __init__(self, half_width: int) -> None: def __init__(self, half_width: int) -> None:
@@ -79,6 +79,9 @@ class RouteResult:
#: what each routed connection joins, and the zone both ends sit in #: what each routed connection joins, and the zone both ends sit in
#: (or ""), parallel to ``connections`` #: (or ""), parallel to ``connections``
self.connection_ends: list[tuple[str, str, str]] = [] self.connection_ends: list[tuple[str, str, str]] = []
#: for each routed connection, the earlier ones (positions in
#: ``connections``) whose copper it ended on, parallel to ``connections``
self.connection_anchors: list[tuple[int, ...]] = []
#: connections left unrouted: (net_no, one end, the other end) #: connections left unrouted: (net_no, one end, the other end)
self.failed: list[tuple[int, str, str]] = [] self.failed: list[tuple[int, str, str]] = []
#: half width of each net routed wider than the default (its class) #: half width of each net routed wider than the default (its class)
@@ -126,6 +129,10 @@ class _Connection:
"narrow", "narrow",
"half", "half",
"stubs", "stubs",
"stub_near",
"anchors",
"copper",
"seq",
) )
def __init__(self, index: int, net_no: int, a: Pin, b: Pin) -> None: def __init__(self, index: int, net_no: int, a: Pin, b: Pin) -> None:
@@ -143,6 +150,8 @@ class _Connection:
self.halo_nodes: list[Node] = [] self.halo_nodes: list[Node] = []
# each end's stub: its layer, its copper tiles, and the nodes it claims # each end's stub: its layer, its copper tiles, and the nodes it claims
self.stubs: list[tuple[int, list[IntBox], set[Node]]] = [] self.stubs: list[tuple[int, list[IntBox], set[Node]]] = []
# every node its stubs come near, claimed or not (see GridRouter._stub_near)
self.stub_near: list[Node] = []
# the pins and zones each end may use, and which pin the route ended # the pins and zones each end may use, and which pin the route ended
# on (None when it ended on a zone) # on (None when it ended on a zone)
self.a_group: tuple[list[Pin], list] = ([a], []) self.a_group: tuple[list[Pin], list] = ([a], [])
@@ -155,6 +164,14 @@ class _Connection:
# routed at the default width instead; the half width it went in at # routed at the default width instead; the half width it went in at
self.narrow = False self.narrow = False
self.half = 0 self.half = 0
# connections whose copper this one ended on (a T into its net's
# tree): ripping one of them leaves this one dangling
self.anchors: frozenset[int] = frozenset()
# the nodes of its committed copper (path cells, via cells on every
# layer), where another connection of its net may end
self.copper: frozenset[Node] = frozenset()
# commit order: a connection is always committed after its anchors
self.seq = 0
class GridRouter: class GridRouter:
@@ -180,17 +197,46 @@ class GridRouter:
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
rollback: bool = True, rollback: bool = True,
net_widths: dict[int, int] | None = None, net_widths: dict[int, int] | None = None,
via_drill: int | None = None, via_drill: int | None = None,
hole_to_hole: int = 0, hole_to_hole: int = 0,
tree_nets: bool = True,
only_nets: frozenset | None = None,
bounds: IntBox | None = None,
) -> None: ) -> None:
self.board = board self.board = board
# A window re-route routes some nets inside part of the board: only
# these nets get connections, and the grid covers only ``bounds``
# (cells outside it do not exist, so nothing is routed there).
self.only_nets = frozenset(only_nets) if only_nets is not None else None
self._bounds = bounds
# connections with an end outside ``bounds``: never searched, since
# the grid has no cells to reach that end by
self._outside: set[int] = set()
# Multi-pin nets: pair a net's pin groups by a minimum spanning tree,
# and let a connection start or end on copper its net already routed
# (a T into the tree), not only on one chosen pin.
self.tree = bool(tree_nets)
self._dependents: dict[int, set[int]] = {}
self._commits = 0
self._plane_nets: set[int] = set()
self._net_conns: dict[int, list[_Connection]] = {}
# Pin access: while a pin still has connections to route, the cells # Pin access: while a pin still has connections to route, the cells
# its route would leave by (its end cells, the via it may need there, # its route would leave by (its end cells, the via it may need there,
# and the clearance around both) cost other nets this much extra, so # and the clearance around both) cost other nets this much extra, so
# they route round a fine-pitch pin's way out instead of sealing it. # they route round a fine-pitch pin's way out instead of sealing it.
self.access_cost = max(float(access_cost), 0.0) self.access_cost = max(float(access_cost), 0.0)
# Negotiated congestion (PathFinder): before the real routing, every
# connection is routed this many times on the empty board, where routes
# may overlap at a price that grows where they compete. The cells that
# stay contested keep a history cost the real routing pays, so the first
# routes leave room around the places later routes have no way round.
self.negotiate = max(int(negotiate), 0)
self._history: dict[Node, float] = {}
self._present: dict[Node, dict[int, int]] | None = None
self._present_cost = 0.0
self._doorways: dict[Node, list[tuple[int, int]]] = {} self._doorways: dict[Node, list[tuple[int, int]]] = {}
self._pending: dict[int, int] = {} self._pending: dict[int, int] = {}
# Rip-up as a transaction: the connections a rip-up route crosses are # Rip-up as a transaction: the connections a rip-up route crosses are
@@ -208,6 +254,12 @@ class GridRouter:
self._escape_cells = 12 self._escape_cells = 12
self._crowded_cache: dict = {} self._crowded_cache: dict = {}
self._trapped_cache: dict = {} self._trapped_cache: dict = {}
# pin location -> where a pin on a turned fine-pitch pad leaves its
# pin row along the pad's axis (None: it leaves like any other pin)
self._axis_exits: dict[IntPoint, IntPoint | None] = {}
# and the other nets' pads near each such pin, its stubs' obstacles
self._axis_pads: dict[IntPoint, list] = {}
self._part_centres: dict[int, tuple[float, float] | None] = {}
self.heuristic_weight = max(float(heuristic_weight), 1.0) self.heuristic_weight = max(float(heuristic_weight), 1.0)
self.trace_width = max(trace_width, 1) self.trace_width = max(trace_width, 1)
self.clearance = max(clearance, 0) self.clearance = max(clearance, 0)
@@ -282,6 +334,11 @@ class GridRouter:
self.layers = list(layers) self.layers = list(layers)
box = board.bounding_box box = board.bounding_box
if bounds is not None:
box = IntBox(
max(box.ll.x, bounds.ll.x), max(box.ll.y, bounds.ll.y),
min(box.ur.x, bounds.ur.x), min(box.ur.y, bounds.ur.y),
)
self.origin_x = box.ll.x self.origin_x = box.ll.x
self.origin_y = box.ll.y self.origin_y = box.ll.y
self.cols = max(1, math.ceil((box.ur.x - box.ll.x) / self.step) + 1) self.cols = max(1, math.ceil((box.ur.x - box.ll.x) / self.step) + 1)
@@ -299,9 +356,15 @@ class GridRouter:
self._zone_cells: dict[int, list[Node]] = {} self._zone_cells: dict[int, list[Node]] = {}
# per-connection occupancy (owner = connection index) # per-connection occupancy (owner = connection index)
self._cell_owner: dict[Node, int] = {} self._cell_owner: dict[Node, int] = {}
self._via_owner: dict[Cell, int] = {} # Node -> connections whose stub comes near it. A cell has one owner,
# and a stub claims only cells nobody owns yet, so where several pins
# leave side by side (a QFN turned 45 degrees: neighbours 0.35 mm apart
# on each axis) the cell two stubs share names only the first, and the
# exact check between the later stubs would never run.
self._stub_near: dict[Node, set[int]] = {}
# every connection whose via covers a cell, in claim order: a via two # every connection whose via covers a cell, in claim order: a via two
# connections share still blocks after the first of them is ripped # connections share still blocks after the first of them is ripped,
# and a route through it must rip all of them
self._via_claims: dict[Cell, list[int]] = {} self._via_claims: dict[Cell, list[int]] = {}
# trace halos: node -> indices of the connections claiming it # trace halos: node -> indices of the connections claiming it
self._halo: dict[Node, list[int]] = {} self._halo: dict[Node, list[int]] = {}
@@ -520,14 +583,19 @@ class GridRouter:
if owner is not None and conns[owner].net_no != net_no: if owner is not None and conns[owner].net_no != net_no:
blocking = owner blocking = owner
else: else:
via_owner = self._via_owner.get(cell) blocking = self._via_blocker(cell, net_no, conns)
if via_owner is not None and conns[via_owner].net_no != net_no:
blocking = via_owner
if blocking is None: if blocking is None:
for i in self._halo.get(node, ()): for i in self._halo.get(node, ()):
if conns[i].net_no != net_no: if conns[i].net_no != net_no:
blocking = i blocking = i
break break
if blocking is None:
# another net's pin stub comes too close, though the cell it once
# claimed may since have been freed by a rip of its first owner
for i in self._stub_near.get(node, ()):
if conns[i].net_no != net_no:
blocking = i
break
if blocking is None: if blocking is None:
return 0.0 return 0.0
if not allow_ripup: if not allow_ripup:
@@ -537,6 +605,17 @@ class GridRouter:
return None return None
return self.rip_penalty * (1 + rip_count) return self.rip_penalty * (1 + rip_count)
def _via_others(self, cell: Cell, net_no: int, conns: list[_Connection]) -> list[int]:
"""Connections of other nets whose via covers ``cell``: all of them,
since two connections of a net can share one via."""
return [i for i in self._via_claims.get(cell, ()) if conns[i].net_no != net_no]
def _via_blocker(self, cell: Cell, net_no: int, conns: list[_Connection]) -> int | None:
"""The other net's via connection on ``cell`` hardest to rip (the
penalty and the rip cap go by it), or None."""
others = self._via_others(cell, net_no, conns)
return max(others, key=lambda i: conns[i].rip_count) if others else None
def _via_cells(self, cell: Cell) -> list[Cell]: def _via_cells(self, cell: Cell) -> list[Cell]:
"""The cell a via sits in plus the neighbours its copper reaches.""" """The cell a via sits in plus the neighbours its copper reaches."""
r = self.via_reach r = self.via_reach
@@ -642,6 +721,8 @@ class GridRouter:
def _search( def _search(
self, conn: _Connection, allow_ripup: bool, conns: list[_Connection] self, conn: _Connection, allow_ripup: bool, conns: list[_Connection]
) -> list[Node] | None: ) -> list[Node] | None:
if conn.index in self._outside:
return None
half = self._conn_half(conn) half = self._conn_half(conn)
self._cur_half, self._spread = half, self._spread_for(half) self._cur_half, self._spread = half, self._spread_for(half)
try: try:
@@ -658,6 +739,13 @@ class GridRouter:
goal_cell = self._group_target(conn.a_group) goal_cell = self._group_target(conn.a_group)
starts = self._group_ends(conn.a_group, conn.net_no, conns, allow_ripup) starts = self._group_ends(conn.a_group, conn.net_no, conns, allow_ripup)
goals = self._group_ends(conn.b_group, conn.net_no, conns, allow_ripup) goals = self._group_ends(conn.b_group, conn.net_no, conns, allow_ripup)
# either side may also start or end on copper its net already routed
a_tree = self._tree_ends(conn, conn.a_group)
b_tree = self._tree_ends(conn, conn.b_group)
for node in a_tree:
starts.setdefault(node, None)
for node in b_tree:
goals.setdefault(node, None)
if not starts or not goals: if not starts or not goals:
return None return None
# A start that is already an end joins at once, except that ending on # A start that is already an end joins at once, except that ending on
@@ -670,6 +758,7 @@ class GridRouter:
] ]
if common: if common:
conn.a_end, conn.b_end = starts[common[0]], goals[common[0]] conn.a_end, conn.b_end = starts[common[0]], goals[common[0]]
conn.anchors = _anchors([common[0]], starts, goals, a_tree, b_tree)
return [common[0]] return [common[0]]
net_no = conn.net_no net_no = conn.net_no
@@ -735,6 +824,7 @@ class GridRouter:
if ok: if ok:
path = _reconstruct(came_from, current) path = _reconstruct(came_from, current)
conn.a_end, conn.b_end = starts.get(path[0]), end conn.a_end, conn.b_end = starts.get(path[0]), end
conn.anchors = _anchors(path, starts, goals, a_tree, b_tree)
return path return path
cx, cy, cl = current cx, cy, cl = current
base = g_score[current] base = g_score[current]
@@ -758,6 +848,8 @@ class GridRouter:
continue continue
if self._doorways: if self._doorways:
enter += self._access(nxt, net_no) enter += self._access(nxt, net_no)
if self._history or self._present is not None:
enter += self._congestion(nxt, net_no)
step = 1.0 if dx == 0 or dy == 0 else math.sqrt(2) step = 1.0 if dx == 0 or dy == 0 else math.sqrt(2)
self._relax( self._relax(
current, nxt, base + step + enter, goal_cell, g_score, came_from, open_heap current, nxt, base + step + enter, goal_cell, g_score, came_from, open_heap
@@ -770,12 +862,64 @@ class GridRouter:
if layer == cl: if layer == cl:
continue continue
nxt = (cx, cy, layer) nxt = (cx, cy, layer)
if g_via < g_score.get(nxt, math.inf): g_layer = g_via
if self._history or self._present is not None:
g_layer += self._congestion(nxt, net_no)
if g_layer < g_score.get(nxt, math.inf):
heapq.heappush( heapq.heappush(
open_heap, (g_via + self._h(nxt, goal_cell), nxt, g_via, current) open_heap, (g_layer + self._h(nxt, goal_cell), nxt, g_layer, current)
) )
return None return None
def _tree_ends(self, conn: _Connection, group) -> dict[Node, frozenset[int]]:
"""Copper its net has already routed on ``group``'s side of ``conn``: a
route may start or end anywhere on it. Each node maps to what a route
ending there relies on: the connection that laid the copper and every
one between it and ``group`` (routed connections of a net form a
forest, so that path is unique). Ripping any of them would cut the
route off. Empty for plane nets, which keep their drops to the plane,
and when tree routing is off."""
if not self.tree or conn.net_no in self._plane_nets:
return {}
adjacent: dict[int, list[tuple[int, _Connection]]] = {}
for c in self._net_conns.get(conn.net_no, ()):
if c is conn or not c.routed:
continue
a, b = id(c.a_group), id(c.b_group)
adjacent.setdefault(a, []).append((b, c))
adjacent.setdefault(b, []).append((a, c))
owners: dict[Node, frozenset[int]] = {}
path_to: dict[int, frozenset[int]] = {id(group): frozenset()}
stack = [id(group)]
while stack:
here = stack.pop()
for other, c in adjacent.get(here, ()):
if other in path_to:
continue
path = path_to[here] | {c.index}
path_to[other] = path
stack.append(other)
for node in c.copper:
# a walled cell's via moved into the pad: no copper there
if node not in self._keepout and node not in self._via_only:
owners.setdefault(node, path)
return owners
def _with_dependents(self, victims: list[_Connection], conns: list[_Connection]) -> list[_Connection]:
"""``victims`` and every routed connection that ended on their copper,
directly or through another: ripping a route rips the routes teed onto
it, which would otherwise dangle. Anchors come before what hangs on
them, as they were committed."""
found = {v.index: v for v in victims}
stack = list(victims)
while stack:
for i in self._dependents.get(stack.pop().index, ()):
c = conns[i]
if c.routed and i not in found:
found[i] = c
stack.append(c)
return sorted(found.values(), key=lambda c: (c.seq, c.index))
# --- pin stubs ---------------------------------------------------------- # --- pin stubs ----------------------------------------------------------
# A pin rarely sits on a cell centre, so every route starts and ends with a # A pin rarely sits on a cell centre, so every route starts and ends with a
# short stub from the pin to its first cell. The grid has to see that # short stub from the pin to its first cell. The grid has to see that
@@ -833,30 +977,143 @@ class GridRouter:
clearance of the pad next door, though the straight exit clears it. clearance of the pad next door, though the straight exit clears it.
""" """
end = self._cell_center(cell) end = self._cell_center(cell)
dx, dy = end.x - pin_location.x, end.y - pin_location.y head = [pin_location]
start = pin_location
exit_point = self._axis_exits.get(pin_location)
if exit_point is not None:
# a pin on a turned fine-pitch pad first leaves along the pad's
# axis, past the pin row, then takes the usual L to its cell
head = [pin_location, exit_point]
start = exit_point
dx, dy = end.x - start.x, end.y - start.y
if not self._orthogonal or dx == 0 or dy == 0: if not self._orthogonal or dx == 0 or dy == 0:
return [pin_location, end] tail = [end]
if abs(dx) >= abs(dy): elif abs(dx) >= abs(dy):
return [pin_location, IntPoint(end.x, pin_location.y), end] tail = [IntPoint(end.x, start.y), end]
return [pin_location, IntPoint(pin_location.x, end.y), end] else:
tail = [IntPoint(start.x, end.y), end]
points = []
for point in head + tail:
if not points or points[-1] != point:
points.append(point)
return points if len(points) > 1 else [pin_location, end]
def _leg_shapes(self, points: list[IntPoint], half: int, grow: int = 0) -> list:
"""A stub's copper, grown by ``grow``: a box per straight leg and per
inner corner, and an exact slab for a slanted leg (a pad-axis exit),
whose bounding box would reach the neighbouring pads."""
shapes: list = []
for a, b in zip(points, points[1:], strict=False):
if a == b:
continue
if a.x == b.x or a.y == b.y:
box = segment_box(a, b, half)
shapes.append(box.offset(grow) if grow else box)
else:
shapes.append(segment_slab(a, b, half + grow))
for c in points[1:-1]:
box = corner_box(c, half)
shapes.append(box.offset(grow) if grow else box)
return shapes
def _axis_exit(self, pin: Pin) -> IntPoint | None:
"""Where a pin on a turned fine-pitch pad clears its pin row.
A QFN placed at 45 degrees has no straight exit on the grid: every
horizontal or vertical step from a pin passes its neighbours closer
than the clearance. The way out is along the pad's own axis, away
from the part, until an L from there to a grid cell clears every
other net's pad (checked on exact shapes, as the exact engine will).
Any angle off the grid axes counts, not just 45 degrees.
"""
loc = pin.location
if loc in self._axis_exits:
return self._axis_exits[loc]
self._axis_exits[loc] = None
shape = pin.shape
if not isinstance(shape, Simplex) or shape.is_int_box():
return None
corners = [shape.corner_approx(i) for i in range(shape.border_line_count())]
edges = [(b.x - a.x, b.y - a.y) for a, b in zip(corners, corners[1:] + corners[:1], strict=False)]
lengths = [math.hypot(dx, dy) for dx, dy in edges]
if len(edges) < 3 or max(lengths) < 1.25 * min(lengths):
return None # no long axis to leave along
dx, dy = edges[lengths.index(max(lengths))]
ux, uy = dx / max(lengths), dy / max(lengths)
if min(abs(ux), abs(uy)) < 0.17:
return None # within ten degrees of a grid axis: the usual exits work
centre = self._part_centre(pin)
if centre is None:
return None
if (loc.x - centre[0]) * ux + (loc.y - centre[1]) * uy < 0:
ux, uy = -ux, -uy
reach = max((c.x - loc.x) * ux + (c.y - loc.y) * uy for c in corners)
h, cl = self.half_width, self.clearance
span = reach + h + cl + 16 * self.step
others = [
p.shape for p in self.board.get_pins()
if p.shape is not None and p is not pin and not set(p.net_nos) & set(pin.net_nos)
and set(p.layers) & set(pin.layers)
and abs(p.location.x - loc.x) < 2 * span and abs(p.location.y - loc.y) < 2 * span
]
self._axis_pads[loc] = others
for j in range(16):
d = reach + h + cl + j * self.step / 2
exit_point = IntPoint(round(loc.x + ux * d), round(loc.y + uy * d))
out = segment_slab(loc, exit_point, h + cl)
if any(overlaps_2d(out, o) for o in others):
continue
ex, ey = self._cell_of(exit_point)
self._axis_exits[loc] = exit_point
for ddx, ddy in itertools.product((0, -1, 1), repeat=2):
cell = (ex + ddx, ey + ddy)
if not (0 <= cell[0] < self.cols and 0 <= cell[1] < self.rows):
continue
legs = self._leg_shapes(self._stub_points(loc, cell)[1:], h, cl)
if not any(overlaps_2d(g, o) for g in legs for o in others):
return exit_point
self._axis_exits[loc] = None
return None
def _exit_clips_a_pad(self, pin: Pin, cell: Cell) -> bool:
"""Whether the stub from an axis exit to ``cell`` comes closer than the
clearance to another net's pad (exactly, as the exact engine checks):
the exit was chosen with one clear cell, not every cell around it."""
legs = self._leg_shapes(
self._stub_points(pin.location, cell)[1:], self._cur_half, self.clearance
)
return any(overlaps_2d(g, pad) for g in legs for pad in self._axis_pads.get(pin.location, ()))
def _part_centre(self, pin: Pin) -> tuple[float, float] | None:
key = pin.component_no
if key not in self._part_centres:
mates = [p.location for p in self.board.get_pins() if p.component_no == key] if key else []
self._part_centres[key] = (
(sum(m.x for m in mates) / len(mates), sum(m.y for m in mates) / len(mates))
if len(mates) > 2 else None
)
return self._part_centres[key]
def _stub_cells(self, pin_location: IntPoint, cell: Cell, half: int | None = None) -> list[Cell]: def _stub_cells(self, pin_location: IntPoint, cell: Cell, half: int | None = None) -> list[Cell]:
"""Cells where another net's trace would come too close to the stub.""" """Cells where another net's trace would come too close to the stub."""
from freeroute.board.outline import _point_segment from rpmroute.board.outline import _point_segment
points = self._stub_points(pin_location, cell) points = self._stub_points(pin_location, cell)
end = points[-1]
reach = (half or self._cur_half) + self.half_width + self.clearance reach = (half or self._cur_half) + self.half_width + self.clearance
box = IntBox( box = IntBox(
min(pin_location.x, end.x), min(pin_location.y, end.y), min(p.x for p in points), min(p.y for p in points),
max(pin_location.x, end.x), max(pin_location.y, end.y), max(p.x for p in points), max(p.y for p in points),
) )
legs = list(zip(points, points[1:], strict=False)) legs = list(zip(points, points[1:], strict=False))
return [ joints = points[1:] # each carries a square corner tile
c
for c in self._cells_in_box(box, reach) def near(c) -> bool:
if min(_point_segment(self._cell_center(c), a, b) for a, b in legs) < reach p = self._cell_center(c)
] if min(_point_segment(p, a, b) for a, b in legs) < reach:
return True
return any(max(abs(p.x - j.x), abs(p.y - j.y)) < reach for j in joints)
return [c for c in self._cells_in_box(box, reach) if near(c)]
def _stub_clear( def _stub_clear(
self, self,
@@ -872,13 +1129,12 @@ class GridRouter:
if keepouts: if keepouts:
# the stub is off the grid, so check it exactly, as the exact # the stub is off the grid, so check it exactly, as the exact
# engine will: its copper grown by clearance must miss every keepout # engine will: its copper grown by clearance must miss every keepout
from freeroute.geometry.polyline import Polyline, PolylineShape
points = self._stub_points(pin.location, cell) points = self._stub_points(pin.location, cell)
if points[-1] != pin.location: if points[-1] != pin.location:
for tile in PolylineShape(Polyline(points), self._cur_half).tiles(): legs = self._leg_shapes(points, self._cur_half)
grown = tile.offset(self.clearance) grown_legs = self._leg_shapes(points, self._cur_half, self.clearance)
if any(k.overlaps(grown if needs else tile) for k, needs in keepouts): for tile, grown in zip(legs, grown_legs, strict=True):
if any(overlaps_2d(k, grown if needs else tile) for k, needs in keepouts):
return False return False
# the track's round end at the pin, for a rule area # the track's round end at the pin, for a rule area
cap = corner_box(pin.location, self._cur_half) cap = corner_box(pin.location, self._cur_half)
@@ -892,15 +1148,16 @@ class GridRouter:
allow_ripup and all(conns[i].rip_count < self.rip_cap for i in owners) allow_ripup and all(conns[i].rip_count < self.rip_cap for i in owners)
) )
def _stub_tiles(self, pin_location: IntPoint, cell: Cell, half: int) -> list[IntBox]: def _stub_tiles(self, pin_location: IntPoint, cell: Cell, half: int, grow: int = 0) -> list:
"""The stub's copper: its legs, and a square at each corner and at the """The stub's copper (grown by ``grow``): its legs, and a square at each
cell end, where the route carries on.""" corner and at the cell end, where the route carries on."""
points = self._stub_points(pin_location, cell) points = self._stub_points(pin_location, cell)
tiles = [corner_box(point, half) for point in points[1:]] tiles: list = [
corner_box(point, half).offset(grow) if grow else corner_box(point, half)
for point in points[1:]
]
if len(points) > 1 and points[-1] != pin_location: if len(points) > 1 and points[-1] != pin_location:
from freeroute.geometry.polyline import Polyline, PolylineShape tiles += self._leg_shapes(points, half, grow)
tiles += PolylineShape(Polyline(points), half).tiles()
return tiles return tiles
def _stub_owners( def _stub_owners(
@@ -920,16 +1177,24 @@ class GridRouter:
other = [tiles for lay, tiles, nodes in conns[owner].stubs if node in nodes] other = [tiles for lay, tiles, nodes in conns[owner].stubs if node in nodes]
if other: if other:
if grown is None: if grown is None:
grown = [ grown = self._stub_tiles(
t.offset(self.clearance) pin.location, cell, half or self._cur_half, self.clearance
for t in self._stub_tiles(pin.location, cell, half or self._cur_half) )
] if not any(overlaps_2d(g, t) for tiles in other for t in tiles for g in grown):
if not any(g.overlaps(t) for tiles in other for t in tiles for g in grown):
continue continue
owners.add(owner) owners.add(owner)
via_owner = self._via_owner.get(c) for idx in self._stub_near.get(node, ()):
if via_owner is not None and conns[via_owner].net_no != net_no: if idx in owners or conns[idx].net_no == net_no:
owners.add(via_owner) continue
theirs = [tiles for lay, tiles, _ in conns[idx].stubs if lay == layer]
if theirs:
if grown is None:
grown = self._stub_tiles(
pin.location, cell, half or self._cur_half, self.clearance
)
if any(overlaps_2d(g, t) for tiles in theirs for t in tiles for g in grown):
owners.add(idx)
owners.update(self._via_others(c, net_no, conns))
return owners return owners
def _end_penalty(self, pin: Pin, node: Node, net_no: int, allow_ripup: bool, conns) -> float: def _end_penalty(self, pin: Pin, node: Node, net_no: int, allow_ripup: bool, conns) -> float:
@@ -1009,11 +1274,16 @@ class GridRouter:
return self._cell_of(IntPoint((box.ll.x + box.ur.x) // 2, (box.ll.y + box.ur.y) // 2)) return self._cell_of(IntPoint((box.ll.x + box.ur.x) // 2, (box.ll.y + box.ur.y) // 2))
def _stub_cost(self, pin: Pin, node: Node) -> float: def _stub_cost(self, pin: Pin, node: Node) -> float:
c = self._cell_center(node[:2]) if self._axis_exits.get(pin.location) is None:
dx, dy = abs(c.x - pin.location.x), abs(c.y - pin.location.y) c = self._cell_center(node[:2])
if self._orthogonal: # measured the way the route itself is allowed to move dx, dy = abs(c.x - pin.location.x), abs(c.y - pin.location.y)
return (dx + dy) / self.step if self._orthogonal: # measured the way the route itself is allowed to move
return math.hypot(dx, dy) / self.step return (dx + dy) / self.step
return math.hypot(dx, dy) / self.step
points = self._stub_points(pin.location, node[:2])
return sum(
math.hypot(b.x - a.x, b.y - a.y) for a, b in zip(points, points[1:], strict=False)
) / self.step
def _end_nodes(self, pin: Pin, net_no: int, conns, allow_ripup: bool = False) -> set[Node]: def _end_nodes(self, pin: Pin, net_no: int, conns, allow_ripup: bool = False) -> set[Node]:
"""Nodes a route may start or end on for ``pin``: the nearest cell and """Nodes a route may start or end on for ``pin``: the nearest cell and
@@ -1023,14 +1293,21 @@ class GridRouter:
everywhere else, or a pin whose only way out another net has taken everywhere else, or a pin whose only way out another net has taken
could never have it back.""" could never have it back."""
layers = [layer for layer in pin.layers if layer in self.layers] layers = [layer for layer in pin.layers if layer in self.layers]
cx, cy = self._cell_of(pin.location) exit_point = None
if self._orthogonal and self._crowded(pin, net_no):
exit_point = self._axis_exit(pin)
cx, cy = self._cell_of(exit_point if exit_point is not None else pin.location)
nodes: set[Node] = set() nodes: set[Node] = set()
for dx, dy in ((0, 0), *self._neighbours): for dx, dy in ((0, 0), *self._neighbours):
cell = (cx + dx, cy + dy) cell = (cx + dx, cy + dy)
if not (0 <= cell[0] < self.cols and 0 <= cell[1] < self.rows): if not (0 <= cell[0] < self.cols and 0 <= cell[1] < self.rows):
continue continue
if exit_point is not None and self._exit_clips_a_pad(pin, cell):
continue
for layer in layers: for layer in layers:
if (dx or dy) and self._enter_cost(cell, layer, net_no, allow_ripup, conns) is None: # the pin's own cell is in its pad; an exit cell is not
checked = dx or dy or exit_point is not None
if checked and self._enter_cost(cell, layer, net_no, allow_ripup, conns) is None:
continue continue
if self._stub_clear(pin, cell, layer, net_no, conns, allow_ripup=allow_ripup): if self._stub_clear(pin, cell, layer, net_no, conns, allow_ripup=allow_ripup):
nodes.add((*cell, layer)) nodes.add((*cell, layer))
@@ -1040,6 +1317,11 @@ class GridRouter:
# cost, so it is only taken where a short step would not do. # cost, so it is only taken where a short step would not do.
if self._orthogonal and self._crowded(pin, net_no) and self._trapped(pin, net_no, nodes): if self._orthogonal and self._crowded(pin, net_no) and self._trapped(pin, net_no, nodes):
nodes |= self._escape_nodes(pin, net_no, conns, layers, (cx, cy), allow_ripup) nodes |= self._escape_nodes(pin, net_no, conns, layers, (cx, cy), allow_ripup)
if not nodes and exit_point is not None:
# every cell past the pin row is taken: report no way out, so the
# search goes on to rip-up, rather than fall back to a cell out in
# the open on top of another net's route
return nodes
if not nodes: # nothing clear: fall back to the nearest cell, as before if not nodes: # nothing clear: fall back to the nearest cell, as before
nodes = {(cx, cy, layer) for layer in layers} nodes = {(cx, cy, layer) for layer in layers}
if self._keepout_boxes and not any( if self._keepout_boxes and not any(
@@ -1113,7 +1395,6 @@ class GridRouter:
whose stub from the pin clears every other net's pad by the full whose stub from the pin clears every other net's pad by the full
clearance, checked on the stub's copper tiles as the exact engine clearance, checked on the stub's copper tiles as the exact engine
will rather than on the grid.""" will rather than on the grid."""
from freeroute.geometry.polyline import Polyline, PolylineShape
reach = self._escape_cells reach = self._escape_cells
near = [ near = [
@@ -1135,17 +1416,14 @@ class GridRouter:
cell = (cx + dx * k + sx, cy + dy * k + sy) cell = (cx + dx * k + sx, cy + dy * k + sy)
if not (0 <= cell[0] < self.cols and 0 <= cell[1] < self.rows): if not (0 <= cell[0] < self.cols and 0 <= cell[1] < self.rows):
break break
grown = [ grown = self._leg_shapes(
tile.offset(self.clearance) self._stub_points(pin.location, cell), self._cur_half, self.clearance
for tile in PolylineShape( )
Polyline(self._stub_points(pin.location, cell)), self._cur_half
).tiles()
]
for layer in layers: for layer in layers:
if self._enter_cost(cell, layer, net_no, allow_ripup, conns) is None: if self._enter_cost(cell, layer, net_no, allow_ripup, conns) is None:
continue continue
if any( if any(
layer in box_layers and any(g.overlaps(box) for g in grown) layer in box_layers and any(overlaps_2d(g, box) for g in grown)
for box, box_layers in near for box, box_layers in near
): ):
continue continue
@@ -1206,9 +1484,9 @@ class GridRouter:
if conn.index not in claims: if conn.index not in claims:
claims.append(conn.index) claims.append(conn.index)
conn.via_halo.append(c) conn.via_halo.append(c)
self._via_owner.setdefault(c, conn.index)
ends = ((conn.a_end, wire_segs[0], 0), (conn.b_end, wire_segs[-1], -1)) if wire_segs else () ends = ((conn.a_end, wire_segs[0], 0), (conn.b_end, wire_segs[-1], -1)) if wire_segs else ()
conn.stubs = [] conn.stubs = []
self._forget_stubs(conn)
for pin, (layer, cells), at in ends: for pin, (layer, cells), at in ends:
if not isinstance(pin, Pin): if not isinstance(pin, Pin):
continue # ended on a zone or a plane: no stub continue # ended on a zone or a plane: no stub
@@ -1216,6 +1494,8 @@ class GridRouter:
claimed: set[Node] = set() claimed: set[Node] = set()
for c in self._stub_cells(pin.location, cell, half): for c in self._stub_cells(pin.location, cell, half):
node = (*c, layer) node = (*c, layer)
self._stub_near.setdefault(node, set()).add(conn.index)
conn.stub_near.append(node)
if node not in self._cell_owner: if node not in self._cell_owner:
self._cell_owner[node] = conn.index self._cell_owner[node] = conn.index
conn.trace_cells.append((c, layer)) conn.trace_cells.append((c, layer))
@@ -1249,8 +1529,24 @@ class GridRouter:
# via k joins wire segments k and k + 1 # via k joins wire segments k and k + 1
conn.vias[0 if idx == 0 else idx - 1] = location conn.vias[0 if idx == 0 else idx - 1] = location
conn.routed = True conn.routed = True
self._commits += 1
conn.seq = self._commits
conn.copper = frozenset(path) | frozenset(
(*cell, layer) for cell in conn.via_cells for layer in self.layers
)
for anchor in conn.anchors:
self._dependents.setdefault(anchor, set()).add(conn.index)
self._settle(conn, -1) self._settle(conn, -1)
def _forget_stubs(self, conn: _Connection) -> None:
for node in conn.stub_near:
near = self._stub_near.get(node)
if near is not None:
near.discard(conn.index)
if not near:
del self._stub_near[node]
conn.stub_near = []
def _rip(self, conn: _Connection) -> None: def _rip(self, conn: _Connection) -> None:
for cell, layer in conn.trace_cells: for cell, layer in conn.trace_cells:
if self._cell_owner.get((*cell, layer)) == conn.index: if self._cell_owner.get((*cell, layer)) == conn.index:
@@ -1259,11 +1555,6 @@ class GridRouter:
claims = self._via_claims.get(cell) claims = self._via_claims.get(cell)
if claims is not None and conn.index in claims: if claims is not None and conn.index in claims:
claims.remove(conn.index) claims.remove(conn.index)
if self._via_owner.get(cell) == conn.index:
if claims:
self._via_owner[cell] = claims[0]
else:
del self._via_owner[cell]
if claims is not None and not claims: if claims is not None and not claims:
del self._via_claims[cell] del self._via_claims[cell]
conn.via_halo = [] conn.via_halo = []
@@ -1276,6 +1567,7 @@ class GridRouter:
conn.halo_nodes = [] conn.halo_nodes = []
conn.trace_cells = [] conn.trace_cells = []
conn.stubs = [] conn.stubs = []
self._forget_stubs(conn)
for cell in conn.via_cells: for cell in conn.via_cells:
count = self._via_nets.get(cell) count = self._via_nets.get(cell)
if count and count.get(conn.net_no): if count and count.get(conn.net_no):
@@ -1286,6 +1578,12 @@ class GridRouter:
conn.wires = [] conn.wires = []
conn.vias = [] conn.vias = []
conn.routed = False conn.routed = False
for anchor in conn.anchors:
hanging = self._dependents.get(anchor)
if hanging is not None:
hanging.discard(conn.index)
conn.anchors = frozenset()
conn.copper = frozenset()
conn.rip_count += 1 conn.rip_count += 1
self._settle(conn, +1) self._settle(conn, +1)
@@ -1308,12 +1606,13 @@ class GridRouter:
owner = self._cell_owner.get((cx, cy, cl)) owner = self._cell_owner.get((cx, cy, cl))
if owner is not None and conns[owner].net_no != net_no: if owner is not None and conns[owner].net_no != net_no:
owners.add(owner) owners.add(owner)
via_owner = self._via_owner.get((cx, cy)) owners.update(self._via_others((cx, cy), net_no, conns))
if via_owner is not None and conns[via_owner].net_no != net_no:
owners.add(via_owner)
for i in self._halo.get((cx, cy, cl), ()): for i in self._halo.get((cx, cy, cl), ()):
if conns[i].net_no != net_no: if conns[i].net_no != net_no:
owners.add(i) owners.add(i)
for i in self._stub_near.get((cx, cy, cl), ()):
if conns[i].net_no != net_no:
owners.add(i)
return owners return owners
# --- pin access --------------------------------------------------------- # --- pin access ---------------------------------------------------------
@@ -1360,6 +1659,74 @@ class GridRouter:
return self.access_cost return self.access_cost
return 0.0 return 0.0
# --- negotiated congestion --------------------------------------------
def _congestion(self, node: Node, net_no: int) -> float:
"""History of a contested cell, plus while negotiating the price of
sharing it with the other nets on it now."""
cost = self._history.get(node, 0.0)
if self._present is not None:
users = self._present.get(node)
if users:
others = len(users) - (1 if net_no in users else 0)
cost += self._present_cost * others
return cost
def _footprint(self, path: list[Node]) -> set[Node]:
"""The nodes a route claims: its cells and their clearance halo on
its layer, and every via's footprint on all layers."""
wire_segs, via_cells = _split_path(path)
halo = [(0, 0), *self._halo_offsets]
nodes: set[Node] = set()
for layer, cells in wire_segs:
for cx, cy in cells:
for dx, dy in halo:
nodes.add((cx + dx, cy + dy, layer))
for cell in via_cells:
for c in self._via_cells(cell):
for layer in self.layers:
nodes.add((*c, layer))
return nodes
def _negotiate(self, order: list[_Connection], conns: list[_Connection]) -> None:
"""Route every connection on the empty board ``self.negotiate`` times,
letting routes share cells at a price: the number of other nets on a
cell times a factor that doubles every round, plus the cell's history,
which grows by one for every extra net each round it stays shared.
Only the history is kept; the board is left empty."""
present: dict[Node, dict[int, int]] = {}
claimed: dict[int, set[Node]] = {}
ends = [(c, c.a_end, c.b_end) for c in conns]
self._present, self._present_cost = present, 0.5
try:
for _ in range(self.negotiate):
for conn in order:
for node in claimed.pop(conn.index, ()):
users = present[node]
users[conn.net_no] -= 1
if not users[conn.net_no]:
del users[conn.net_no]
path = self._search(conn, allow_ripup=False, conns=conns)
if path is None:
continue
nodes = self._footprint(path)
claimed[conn.index] = nodes
for node in nodes:
users = present.setdefault(node, {})
users[conn.net_no] = users.get(conn.net_no, 0) + 1
shared = 0
for node, users in present.items():
if len(users) > 1:
shared += 1
self._history[node] = self._history.get(node, 0.0) + len(users) - 1
if not shared:
break
self._present_cost *= 2
finally:
self._present = None
for conn, a_end, b_end in ends: # the search picks ends; undo that
conn.a_end, conn.b_end = a_end, b_end
# --- passes ------------------------------------------------------------- # --- passes -------------------------------------------------------------
def route(self) -> RouteResult: def route(self) -> RouteResult:
@@ -1383,6 +1750,8 @@ class GridRouter:
if self.route_first: if self.route_first:
# stable: the promoted keep their order among themselves, as do the rest # stable: the promoted keep their order among themselves, as do the rest
order.sort(key=lambda c: (c.net_no, *_ends_of(c)) not in self.route_first) order.sort(key=lambda c: (c.net_no, *_ends_of(c)) not in self.route_first)
if self.negotiate:
self._negotiate(order, conns)
for _ in range(passes): for _ in range(passes):
changed = False changed = False
for conn in order: for conn in order:
@@ -1430,7 +1799,7 @@ class GridRouter:
crossed |= self._stub_owners( crossed |= self._stub_owners(
end, node[:2], node[2], conn.net_no, conns, self._conn_half(conn) end, node[:2], node[2], conn.net_no, conns, self._conn_half(conn)
) )
victims = [conns[i] for i in sorted(crossed)] victims = self._with_dependents([conns[i] for i in sorted(crossed)], conns)
if self.rollback: if self.rollback:
return self._ripup_transaction(conn, path, victims, conns) return self._ripup_transaction(conn, path, victims, conns)
for victim in victims: for victim in victims:
@@ -1441,7 +1810,7 @@ class GridRouter:
def _ripup_transaction(self, conn, path, victims, conns) -> bool: def _ripup_transaction(self, conn, path, victims, conns) -> bool:
"""Route ``conn`` through ``victims``, reroute them at once in free """Route ``conn`` through ``victims``, reroute them at once in free
space, and undo it all if fewer connections end up routed.""" space, and undo it all if fewer connections end up routed."""
saved = [(v, v.path, v.a_end, v.b_end, v.rip_count) for v in victims] saved = [(v, v.path, v.a_end, v.b_end, v.rip_count, v.anchors) for v in victims]
own_rips = conn.rip_count own_rips = conn.rip_count
for victim in victims: for victim in victims:
self._rip(victim) self._rip(victim)
@@ -1459,8 +1828,8 @@ class GridRouter:
self._rip(victim) self._rip(victim)
self._rip(conn) self._rip(conn)
conn.rip_count = own_rips conn.rip_count = own_rips
for victim, old_path, a_end, b_end, rips in saved: for victim, old_path, a_end, b_end, rips, anchors in saved:
victim.a_end, victim.b_end = a_end, b_end victim.a_end, victim.b_end, victim.anchors = a_end, b_end, anchors
self._commit(victim, old_path) self._commit(victim, old_path)
victim.rip_count = rips victim.rip_count = rips
return False return False
@@ -1482,8 +1851,11 @@ class GridRouter:
planes_by_net.setdefault(zone.net_nos[0], []).append(zone) planes_by_net.setdefault(zone.net_nos[0], []).append(zone)
plane_ids = frozenset(id(z) for zs in planes_by_net.values() for z in zs) plane_ids = frozenset(id(z) for zs in planes_by_net.values() for z in zs)
conns: list[_Connection] = [] conns: list[_Connection] = []
self._plane_nets: set[int] = set()
nets = set(pins_by_net) | set(zones_by_net) | set(planes_by_net) nets = set(pins_by_net) | set(zones_by_net) | set(planes_by_net)
# deterministic: fewer-pin nets first, then by net number # deterministic: fewer-pin nets first, then by net number
if self.only_nets is not None:
nets &= self.only_nets
for net_no in sorted(nets, key=lambda n: (len(pins_by_net.get(n, [])), n)): for net_no in sorted(nets, key=lambda n: (len(pins_by_net.get(n, [])), n)):
zones = zones_by_net.get(net_no, []) + planes_by_net.get(net_no, []) zones = zones_by_net.get(net_no, []) + planes_by_net.get(net_no, [])
groups = _connected_groups( groups = _connected_groups(
@@ -1494,20 +1866,31 @@ class GridRouter:
# a plane net: every other group goes straight to the plane # a plane net: every other group goes straight to the plane
# (usually a stub and a via), not pad to pad across the board # (usually a stub and a via), not pad to pad across the board
pairs = [(g, hubs[0]) for g in groups if g is not hubs[0]] pairs = [(g, hubs[0]) for g in groups if g is not hubs[0]]
self._plane_nets.add(net_no)
elif self.tree:
pairs = _spanning_pairs(groups)
else: else:
pairs = list(zip(groups, groups[1:], strict=False)) pairs = list(zip(groups, groups[1:], strict=False))
for ga, gb in pairs: for ga, gb in pairs:
conn = _Connection(len(conns), net_no, _first(ga[0]), _first(gb[0])) conn = _Connection(len(conns), net_no, _first(ga[0]), _first(gb[0]))
conn.a_group, conn.b_group = ga, gb conn.a_group, conn.b_group = ga, gb
conns.append(conn) conns.append(conn)
self._net_conns: dict[int, list[_Connection]] = {}
for conn in conns:
self._net_conns.setdefault(conn.net_no, []).append(conn)
if self._bounds is not None:
self._outside = {
c.index for c in conns
if not (_group_inside(c.a_group, self._bounds) and _group_inside(c.b_group, self._bounds))
}
return conns return conns
def _fixed_pieces(self, net_no: int) -> list[_FixedPiece]: def _fixed_pieces(self, net_no: int) -> list[_FixedPiece]:
"""The net's tracks and vias already on the board, as connectivity.""" """The net's tracks and vias already on the board, as connectivity."""
cache = getattr(self, "_fixed_cache", None) cache = getattr(self, "_fixed_cache", None)
if cache is None: if cache is None:
from freeroute.board.items import Trace from rpmroute.board.items import Trace
from freeroute.geometry.polyline import Polyline, PolylineShape, corner_box from rpmroute.geometry.polyline import Polyline, PolylineShape, corner_box
cache = self._fixed_cache = {} cache = self._fixed_cache = {}
for item in self.board.get_items(): for item in self.board.get_items():
@@ -1549,18 +1932,22 @@ class GridRouter:
return wide, narrowed return wide, narrowed
def _snapshot(self, conns: list[_Connection]) -> list[tuple]: def _snapshot(self, conns: list[_Connection]) -> list[tuple]:
# in commit order, so a connection teed onto another comes after it;
# its anchors as positions in this list
routed = sorted((c for c in conns if c.routed), key=lambda c: (c.seq, c.index))
position = {c.index: i for i, c in enumerate(routed)}
return [ return [
(c.net_no, [(layer, list(pts)) for layer, pts in c.wires], list(c.vias), (c.net_no, [(layer, list(pts)) for layer, pts in c.wires], list(c.vias),
(*_ends_of(c), self._left_to_zone(c))) (*_ends_of(c), self._left_to_zone(c)),
for c in conns tuple(sorted(position[a] for a in c.anchors if a in position)))
if c.routed for c in routed
] ]
def _result_from(self, snapshot, unrouted: int) -> RouteResult: def _result_from(self, snapshot, unrouted: int) -> RouteResult:
result = RouteResult(self.half_width) result = RouteResult(self.half_width)
written: set[tuple[int, IntPoint]] = set() written: set[tuple[int, IntPoint]] = set()
result.unrouted = unrouted result.unrouted = unrouted
for net_no, wires, vias, ends in snapshot: for net_no, wires, vias, ends, anchors in snapshot:
for layer, points in wires: for layer, points in wires:
result.add_wire(net_no, layer, points) result.add_wire(net_no, layer, points)
for location in vias: for location in vias:
@@ -1571,7 +1958,8 @@ class GridRouter:
result.add_via(net_no, location) result.add_via(net_no, location)
result.connections.append((net_no, wires, vias)) result.connections.append((net_no, wires, vias))
result.connection_ends.append(ends) result.connection_ends.append(ends)
routed = {ends[:2] + (net_no,) for net_no, _w, _v, ends in snapshot} result.connection_anchors.append(anchors)
routed = {ends[:2] + (net_no,) for net_no, _w, _v, ends, _a in snapshot}
result.failed = [ result.failed = [
(c.net_no, *_ends_of(c), self._left_to_zone(c)) (c.net_no, *_ends_of(c), self._left_to_zone(c))
for c in self._conns for c in self._conns
@@ -1584,6 +1972,53 @@ def _first(items):
return items[0] if items else None return items[0] if items else None
def _anchors(path, starts, goals, a_tree, b_tree) -> frozenset[int]:
"""What a found path relies on: the connections between the copper it
starts or ends on and its own groups."""
found: set[int] = set()
if starts.get(path[0]) is None and path[0] in a_tree:
found |= a_tree[path[0]]
if goals.get(path[-1]) is None and path[-1] in b_tree:
found |= b_tree[path[-1]]
return frozenset(found)
def _group_points(group) -> list[tuple[int, int]]:
pins, zones = group
if pins:
return [(p.location.x, p.location.y) for p in pins]
points = []
for zone in zones:
box = zone.bounding_box()
points.append(((box.ll.x + box.ur.x) // 2, (box.ll.y + box.ur.y) // 2))
return points or [(0, 0)]
def _spanning_pairs(groups) -> list[tuple]:
"""A minimum spanning tree over a net's groups (Prim, Manhattan distance
between their nearest pins), as (in the tree, joining it) pairs: each
connection joins the nearest group not yet joined, not the next in pin
order."""
if len(groups) < 2:
return []
points = [_group_points(g) for g in groups]
def gap(i: int, j: int) -> int:
return min(abs(ax - bx) + abs(ay - by) for ax, ay in points[i] for bx, by in points[j])
best = {j: (gap(0, j), 0) for j in range(1, len(groups))}
pairs = []
while best:
j = min(best, key=lambda k: (best[k][0], k))
_, i = best.pop(j)
pairs.append((groups[i], groups[j]))
for k in best:
d = gap(j, k)
if d < best[k][0]:
best[k] = (d, j)
return pairs
def _group_label(group) -> str: def _group_label(group) -> str:
pins, zones = group pins, zones = group
parts = [f"{p.component_ref}-{p.name}" for p in pins[:3]] parts = [f"{p.component_ref}-{p.name}" for p in pins[:3]]
@@ -1593,6 +2028,19 @@ def _group_label(group) -> str:
return "/".join(parts) or "?" return "/".join(parts) or "?"
def _group_inside(group, bounds: IntBox) -> bool:
"""A group has a pin inside ``bounds``, or a zone reaching into it."""
pins, zones = group
if any(bounds.ll.x <= p.location.x <= bounds.ur.x and bounds.ll.y <= p.location.y <= bounds.ur.y
for p in pins):
return True
for zone in zones:
box = zone.bounding_box()
if box.ll.x <= bounds.ur.x and bounds.ll.x <= box.ur.x and box.ll.y <= bounds.ur.y and bounds.ll.y <= box.ur.y:
return True
return False
def _ends_of(conn) -> tuple[str, str]: def _ends_of(conn) -> tuple[str, str]:
"""A readable description of what a connection joins.""" """A readable description of what a connection joins."""
return _group_label(conn.a_group), _group_label(conn.b_group) return _group_label(conn.a_group), _group_label(conn.b_group)
@@ -1779,10 +2227,14 @@ def route_board(
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
rollback: bool = True, rollback: bool = True,
tree_nets: bool = True,
net_widths: dict[int, int] | None = None, net_widths: dict[int, int] | None = None,
via_drill: int | None = None, via_drill: int | None = None,
hole_to_hole: int = 0, hole_to_hole: int = 0,
only_nets: frozenset | None = None,
bounds: IntBox | None = None,
) -> RouteResult: ) -> RouteResult:
"""Convenience wrapper: build a :class:`GridRouter` and route the board.""" """Convenience wrapper: build a :class:`GridRouter` and route the board."""
router = GridRouter( router = GridRouter(
@@ -1801,9 +2253,13 @@ def route_board(
seed=seed, seed=seed,
route_first=route_first, route_first=route_first,
access_cost=access_cost, access_cost=access_cost,
negotiate=negotiate,
rollback=rollback, rollback=rollback,
tree_nets=tree_nets,
net_widths=net_widths, net_widths=net_widths,
via_drill=via_drill, via_drill=via_drill,
hole_to_hole=hole_to_hole, hole_to_hole=hole_to_hole,
only_nets=only_nets,
bounds=bounds,
) )
return router.route() return router.route()
@@ -15,8 +15,8 @@ from __future__ import annotations
from concurrent.futures import ProcessPoolExecutor from concurrent.futures import ProcessPoolExecutor
import os import os
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.ses import RoutingResult from rpmroute.ses import RoutingResult
from .pipeline import build_exact_routing_result, build_routing_result from .pipeline import build_exact_routing_result, build_routing_result
@@ -13,14 +13,17 @@ to DSN units (dividing by the resolution) for the SES ``(wire (path ...))`` and
from __future__ import annotations from __future__ import annotations
import re import re
import time
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import DsnBoard, parse_dsn from rpmroute.dsn import DsnBoard, parse_dsn
from freeroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses from rpmroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses
from .exact_router import ExactRouteResult, route_board_exact from .exact_router import ExactRouteResult, route_board_exact
from .grid_router import RouteResult, route_board from .grid_router import RouteResult, route_board
from .room_router import route_board_rooms from .room_router import route_board_rooms
from .vias import reduce_vias as reduce_vias_stage
from .window import window_reroute as window_reroute_stage
__all__ = ["route", "route_dsn_board", "build_routing_result"] __all__ = ["route", "route_dsn_board", "build_routing_result"]
@@ -118,8 +121,11 @@ def route_dsn_board(
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25, hole_to_hole_mm: float = 0.25,
rollback: bool = True, rollback: bool = True,
tree_nets: bool = True,
via_cost: float = 10.0,
) -> tuple[RouteResult, int, list[str]]: ) -> tuple[RouteResult, int, list[str]]:
"""Route a parsed :class:`DsnBoard`; return the board-unit result, the scale, """Route a parsed :class:`DsnBoard`; return the board-unit result, the scale,
and the layer names. ``layers`` restricts routing to those signal-layer and the layer names. ``layers`` restricts routing to those signal-layer
@@ -143,10 +149,13 @@ def route_dsn_board(
seed=seed, seed=seed,
route_first=route_first, route_first=route_first,
access_cost=access_cost, access_cost=access_cost,
negotiate=negotiate,
rollback=rollback, rollback=rollback,
tree_nets=tree_nets,
net_widths=_net_widths_board(dsn, scale), net_widths=_net_widths_board(dsn, scale),
via_drill=_via_drill_board(dsn, scale), via_drill=_via_drill_board(dsn, scale),
hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0, hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
via_cost=via_cost,
) )
return result, scale, [layer.name for layer in dsn.layers] return result, scale, [layer.name for layer in dsn.layers]
@@ -196,8 +205,11 @@ def build_routing_result(
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25, hole_to_hole_mm: float = 0.25,
rollback: bool = True, rollback: bool = True,
tree_nets: bool = True,
via_cost: float = 10.0,
) -> RoutingResult: ) -> RoutingResult:
"""Route ``dsn`` (grid track) and convert to a DSN-unit RoutingResult.""" """Route ``dsn`` (grid track) and convert to a DSN-unit RoutingResult."""
route, scale, layer_names = route_dsn_board( route, scale, layer_names = route_dsn_board(
@@ -205,8 +217,11 @@ def build_routing_result(
edge_clearance_mm=edge_clearance_mm, resolution=resolution, seed=seed, edge_clearance_mm=edge_clearance_mm, resolution=resolution, seed=seed,
route_first=route_first, route_first=route_first,
access_cost=access_cost, access_cost=access_cost,
negotiate=negotiate,
hole_to_hole_mm=hole_to_hole_mm, hole_to_hole_mm=hole_to_hole_mm,
rollback=rollback, rollback=rollback,
tree_nets=tree_nets,
via_cost=via_cost,
) )
return _to_routing_result(route, dsn, scale, layer_names) return _to_routing_result(route, dsn, scale, layer_names)
@@ -225,8 +240,19 @@ def route_dsn_board_exact(
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25, hole_to_hole_mm: float = 0.25,
rollback: bool = True, rollback: bool = True,
tree_nets: bool = True,
window_reroute: int = 0,
window_resolution: int = 4,
window_margin_mm: float = 1.5,
window_budget: float = 0.25,
window_cap: int = 40,
reduce_vias: bool = False,
reduce_vias_budget: float = 0.5,
reduce_vias_margin_mm: float = 2.0,
via_cost: float = 10.0,
) -> tuple[ExactRouteResult, int, list[str]]: ) -> tuple[ExactRouteResult, int, list[str]]:
"""Route a parsed :class:`DsnBoard` with the exact-geometry (orthogonal, """Route a parsed :class:`DsnBoard` with the exact-geometry (orthogonal,
DRC-verified) track; return the exact result, the scale, and layer names. DRC-verified) track; return the exact result, the scale, and layer names.
@@ -238,27 +264,61 @@ def route_dsn_board_exact(
edge_clearance_board = _mm_to_board(dsn, scale, edge_clearance_mm) edge_clearance_board = _mm_to_board(dsn, scale, edge_clearance_mm)
width_board = round(_rule_width_dsn(dsn) * scale) width_board = round(_rule_width_dsn(dsn) * scale)
clearance_board = round(_rule_clearance_dsn(dsn) * scale) clearance_board = round(_rule_clearance_dsn(dsn) * scale)
# the settings a window re-route repeats, at its own resolution
common = {
"heuristic_weight": heuristic_weight,
"via_half": _via_half_board(dsn, scale),
"edge_clearance": edge_clearance_board,
"trace_width": width_board,
"clearance": clearance_board,
"layers": layers,
"max_passes": max_passes,
"rip_up": rip_up,
"shove": shove,
"diagonal": diagonal,
"rollback": rollback,
"tree_nets": tree_nets,
"net_widths": _net_widths_board(dsn, scale),
"via_drill": _via_drill_board(dsn, scale),
"hole_to_hole": _mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
"via_cost": via_cost,
}
started = time.monotonic()
exact = route_board_exact( exact = route_board_exact(
board, board,
resolution=resolution, resolution=resolution,
heuristic_weight=heuristic_weight,
via_half=_via_half_board(dsn, scale),
edge_clearance=edge_clearance_board,
trace_width=width_board,
clearance=clearance_board,
layers=layers,
max_passes=max_passes,
rip_up=rip_up,
shove=shove,
diagonal=diagonal,
seed=seed, seed=seed,
route_first=route_first, route_first=route_first,
access_cost=access_cost, access_cost=access_cost,
rollback=rollback, negotiate=negotiate,
net_widths=_net_widths_board(dsn, scale), **common,
via_drill=_via_drill_board(dsn, scale),
hole_to_hole=_mm_to_board(dsn, scale, hole_to_hole_mm) or 0,
) )
if window_reroute > 0:
via_half = common["via_half"] or max(width_board // 2, 1)
exact.result = window_reroute_stage(
dsn, exact.result, common,
rounds=window_reroute,
resolution=max(int(window_resolution), resolution),
margin=_mm_to_board(dsn, scale, window_margin_mm) or 0,
via_half=via_half,
via_drill=common["via_drill"] or 2 * via_half,
via_name=_via_padstack(dsn),
# a share of what the routing itself took
budget_s=max(float(window_budget), 0.0) * (time.monotonic() - started),
max_windows=window_cap,
)
if reduce_vias:
via_half = common["via_half"] or max(width_board // 2, 1)
exact.result = reduce_vias_stage(
dsn, exact.result, common,
resolution=resolution,
margin=_mm_to_board(dsn, scale, reduce_vias_margin_mm) or 0,
via_half=via_half,
via_drill=common["via_drill"] or 2 * via_half,
via_name=_via_padstack(dsn),
# a share of what the routing itself took
budget_s=max(float(reduce_vias_budget), 0.0) * (time.monotonic() - started),
)
return exact, scale, [layer.name for layer in dsn.layers] return exact, scale, [layer.name for layer in dsn.layers]
@@ -276,8 +336,19 @@ def build_exact_routing_result(
seed: int | None = None, seed: int | None = None,
route_first: frozenset | None = None, route_first: frozenset | None = None,
access_cost: float = 0.0, access_cost: float = 0.0,
negotiate: int = 0,
hole_to_hole_mm: float = 0.25, hole_to_hole_mm: float = 0.25,
rollback: bool = True, rollback: bool = True,
tree_nets: bool = True,
window_reroute: int = 0,
window_resolution: int = 4,
window_margin_mm: float = 1.5,
window_budget: float = 0.25,
window_cap: int = 40,
reduce_vias: bool = False,
reduce_vias_budget: float = 0.5,
reduce_vias_margin_mm: float = 2.0,
via_cost: float = 10.0,
) -> RoutingResult: ) -> RoutingResult:
"""Route ``dsn`` (exact track) and convert to a DSN-unit RoutingResult.""" """Route ``dsn`` (exact track) and convert to a DSN-unit RoutingResult."""
exact, scale, layer_names = route_dsn_board_exact( exact, scale, layer_names = route_dsn_board_exact(
@@ -293,8 +364,19 @@ def build_exact_routing_result(
seed=seed, seed=seed,
route_first=route_first, route_first=route_first,
access_cost=access_cost, access_cost=access_cost,
negotiate=negotiate,
hole_to_hole_mm=hole_to_hole_mm, hole_to_hole_mm=hole_to_hole_mm,
rollback=rollback, rollback=rollback,
tree_nets=tree_nets,
window_reroute=window_reroute,
window_resolution=window_resolution,
window_margin_mm=window_margin_mm,
window_budget=window_budget,
window_cap=window_cap,
reduce_vias=reduce_vias,
reduce_vias_budget=reduce_vias_budget,
reduce_vias_margin_mm=reduce_vias_margin_mm,
via_cost=via_cost,
) )
return _to_routing_result(exact.result, dsn, scale, layer_names) return _to_routing_result(exact.result, dsn, scale, layer_names)
@@ -30,10 +30,10 @@ from __future__ import annotations
from dataclasses import dataclass, field from dataclasses import dataclass, field
import heapq import heapq
from freeroute.board.board import BasicBoard from rpmroute.board.board import BasicBoard
from freeroute.board.items import Pin from rpmroute.board.items import Pin
from freeroute.board.search_tree import ShapeSearchTree, TreeShape from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.geometry import IntBox, IntPoint, Polyline, PolylineShape, shove_segment from rpmroute.geometry import IntBox, IntPoint, Polyline, PolylineShape, shove_segment
from .exact_router import ExactRouteResult, _routable_nets from .exact_router import ExactRouteResult, _routable_nets
from .grid_router import RouteResult from .grid_router import RouteResult
@@ -56,7 +56,7 @@ class _Accepted:
``wires`` / ``vias`` are the *same* list objects as ``RouteResult.wires`` / ``wires`` / ``vias`` are the *same* list objects as ``RouteResult.wires`` /
``.vias`` for this net, so rewriting a shoved wire in place also updates the ``.vias`` for this net, so rewriting a shoved wire in place also updates the
routed output. ``wire_owners`` is parallel to ``wires``: each entry is the routed output. ``wire_owners`` is parallel to ``wires``: each entry is the
list of :class:`~freeroute.board.search_tree.TreeShape` owner ids for that list of :class:`~rpmroute.board.search_tree.TreeShape` owner ids for that
wire's copper tiles, so a later shove can locate, remove, and roll back a wire's copper tiles, so a later shove can locate, remove, and roll back a
specific wire without disturbing a multi-wire net's other connections. specific wire without disturbing a multi-wire net's other connections.
""" """
@@ -1,6 +1,6 @@
"""Shared orthogonal shove primitives for the exact and room routers. """Shared orthogonal shove primitives for the exact and room routers.
The exact-geometry router (:mod:`freeroute.route.exact_router`) grew the first The exact-geometry router (:mod:`rpmroute.route.exact_router`) grew the first
shove implementation; the continuous room router reuses its geometry so both shove implementation; the continuous room router reuses its geometry so both
tracks agree on how a blocking trace's conflicting segment is found, how the tracks agree on how a blocking trace's conflicting segment is found, how the
perpendicular displacement ladder is generated, and how a reshaped trace is perpendicular displacement ladder is generated, and how a reshaped trace is
@@ -19,8 +19,8 @@ from __future__ import annotations
from collections.abc import Iterator from collections.abc import Iterator
from freeroute.board.search_tree import ShapeSearchTree, TreeShape from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.geometry import IntBox, IntPoint, Polyline, PolylineShape from rpmroute.geometry import IntBox, IntPoint, Polyline, PolylineShape
from .exact_router import _conflicting_segment as conflicting_segment from .exact_router import _conflicting_segment as conflicting_segment
+151
View File
@@ -0,0 +1,151 @@
"""Check routed copper that no engine has checked.
The exact engine verifies every connection against exact pad and copper
shapes before it accepts it. The grid and room engines do not: they route on
approximations, and their output can short or crowd another net with nothing
in their report to say so. :func:`verify_result` puts a finished
:class:`RoutingResult` through the same exact geometry the exact engine uses
(its pads, fixed copper and keepouts, wires as boxes or slanted slabs, vias as
their pads) and lists what it finds.
A violation is a pair of different-net coppers on a shared layer, at least one
of them routed, closer than the board's clearance rule. It is a short when the
coppers themselves overlap (or routed copper sits inside a keepout), else a
clearance violation. Pairs are counted per routed segment or via, as KiCad's
DRC counts per item pair; pads already too close to each other in the design
are not the router's and are not counted.
"""
from __future__ import annotations
from dataclasses import dataclass, field
import itertools
from rpmroute.board import build_board
from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from rpmroute.dsn.model import DsnBoard
from rpmroute.geometry import IntBox, IntPoint, segment_box, segment_slab
from rpmroute.geometry.polyline import corner_box
from rpmroute.ses.model import RoutingResult
from .exact_router import insert_static_copper
from .pipeline import _dsn_units_per_um, _rule_clearance_dsn, _via_half_board
# examples kept per kind; the counts are always complete
MAX_EXAMPLES = 5
@dataclass
class Violation:
"""One offending pair: the routed copper's net, what it came too close
to, the layer, and roughly where (mm, DSN coordinates)."""
net: str
other: str
layer: str
x_mm: float
y_mm: float
def __str__(self) -> str:
return f"{self.net} x {self.other} on {self.layer} at ({self.x_mm:.2f}, {self.y_mm:.2f}) mm"
@dataclass
class VerifyReport:
shorts: int = 0
clearance: int = 0
short_examples: list[Violation] = field(default_factory=list)
clearance_examples: list[Violation] = field(default_factory=list)
@property
def clean(self) -> bool:
return not (self.shorts or self.clearance)
def verify_result(dsn: DsnBoard, result: RoutingResult) -> VerifyReport:
"""Check ``result``'s copper against ``dsn``'s pads, keepouts and each
other, with the board's clearance rule."""
board = build_board(dsn)
scale = max(dsn.resolution.value, 1)
clearance = round(_rule_clearance_dsn(dsn) * scale)
signal_layers = [i for i, layer in enumerate(dsn.layers) if layer.is_signal]
layer_index = {layer.name: i for i, layer in enumerate(dsn.layers)}
via_layers = frozenset(signal_layers)
net_numbers = {n.name: i + 1 for i, n in enumerate(dsn.nets)}
names = {number: name for name, number in net_numbers.items()}
tree = ShapeSearchTree()
owner = itertools.count(1)
insert_static_copper(tree, board, signal_layers, owner)
static_names: dict[int, str] = {}
for shape in tree.all_shapes():
static_names[shape.owner] = "keepout" if shape.net_no == -1 else f"pad of {names.get(shape.net_no, '?')}"
via_default = _via_half_board(dsn, scale)
for net in result.nets:
net_no = net_numbers.get(net.name)
if net_no is None:
continue
for wire in net.wires:
layer = layer_index.get(wire.layer)
if layer is None or layer not in signal_layers:
continue
half = max(round(wire.width * scale / 2), 1)
pts = [
IntPoint(round(wire.coords[i] * scale), round(wire.coords[i + 1] * scale))
for i in range(0, len(wire.coords) - 1, 2)
]
on = frozenset({layer})
for a, b in zip(pts, pts[1:], strict=False):
oid = next(owner)
if a.x == b.x or a.y == b.y:
tree.insert(TreeShape(oid, net_no, on, segment_box(a, b, half), routed=True))
else: # a 45-degree or slanted segment, on its exact copper
slab = segment_slab(a, b, half)
tree.insert(TreeShape(
oid, net_no, on, slab.bounding_box(), routed=True,
exact=slab, seg=("slab", a, b, half),
))
# the round end where it meets the next segment, with this one
tree.insert(TreeShape(oid, net_no, on, corner_box(b, half), routed=True))
for via in net.vias:
half = via_default or max(round(_wire_width(net) * scale / 2), 1)
x, y = round(via.x * scale), round(via.y * scale)
tree.insert(TreeShape(
next(owner), net_no, via_layers, IntBox(x - half, y - half, x + half, y + half), routed=True,
))
mm_per_unit = 1 / (_dsn_units_per_um(dsn) * 1000 * scale)
# one entry per pair of items, however many of their tiles meet; a short
# if any of them overlap
by_pair: dict[tuple[int, int], tuple[TreeShape, TreeShape, bool]] = {}
for shape, other, touching in tree.violation_pairs(clearance):
key = (min(shape.owner, other.owner), max(shape.owner, other.owner))
seen = by_pair.get(key)
if seen is None or (touching and not seen[2]):
by_pair[key] = (shape, other, touching)
report = VerifyReport()
for shape, other, touching in by_pair.values():
layer = min(shape.layers & other.layers)
box = shape.tile.intersection(other.tile.offset(clearance))
if box.is_empty():
box = shape.tile
what = names.get(other.net_no, "?") if other.routed else static_names.get(other.owner, "?")
found = Violation(
names.get(shape.net_no, "?"), what, dsn.layers[layer].name,
(box.ll.x + box.ur.x) / 2 * mm_per_unit, (box.ll.y + box.ur.y) / 2 * mm_per_unit,
)
if touching:
report.shorts += 1
if len(report.short_examples) < MAX_EXAMPLES:
report.short_examples.append(found)
else:
report.clearance += 1
if len(report.clearance_examples) < MAX_EXAMPLES:
report.clearance_examples.append(found)
return report
def _wire_width(net) -> float:
return max((w.width for w in net.wires), default=0.0)
+128
View File
@@ -0,0 +1,128 @@
"""Via reduction: a last stage that routes each net again with vias made dear.
The main search prices a layer change at a few millimetres of track, which
is right while the board is crowded and wrong once it is routed: a net that
hopped layers to slip past a route can often stay on one layer around it.
So each net that has vias is ripped and routed again on its own, everything
else held as fixed copper, with the via cost raised; the new copper is kept
only if the net loses no connection and ends with fewer vias.
It reuses the window stage's board: the net's own items and copper, and of
everything else only what lies near the box the net is routed in. The nets
with the most vias go first, and no new net starts once ``budget_s`` is
spent.
"""
from __future__ import annotations
import time
from typing import Any
from rpmroute.board import build_board
from rpmroute.dsn import DsnBoard
from rpmroute.geometry import IntBox
from .exact_router import route_board_exact
from .grid_router import RouteResult
from .window import Copper, _inside, _item_box, _open, _window_board
def _net_box(copper: Copper, pins: list, grow: int) -> IntBox | None:
wires, vias = copper
points = [p for _layer, path in wires for p in path] + list(vias) + pins
if not points:
return None
xs, ys = [p.x for p in points], [p.y for p in points]
return IntBox(min(xs) - grow, min(ys) - grow, max(xs) + grow, max(ys) + grow)
def reduce_vias(
dsn: DsnBoard,
result: RouteResult,
route_args: dict[str, Any],
*,
resolution: int,
margin: int,
via_half: int,
via_drill: int,
via_name: str,
via_cost_factor: float = 8.0,
budget_s: float | None = None,
) -> RouteResult:
"""Route each net with vias again with vias ``via_cost_factor`` times dearer;
keep a net's new copper only when it fails nothing new and has fewer vias.
``route_args`` are the exact engine's settings for the whole board.
``margin`` grows the box around the net's pins and copper that it is
routed in, so it may go round what it used to hop over."""
started = time.monotonic()
copper: dict[int, Copper] = {
net: (list(result.wires.get(net, [])), list(result.vias.get(net, [])))
for net in set(result.wires) | set(result.vias)
}
todo = sorted((n for n, c in copper.items() if c[1]), key=lambda n: -len(set(copper[n][1])))
if not todo:
return result
default_half = result.half_width
half = dict(result.net_half)
failed = list(result.failed)
base = build_board(dsn)
base_items = [(item, _item_box(item)) for item in base.get_items()]
layers = route_args.get("layers") or [
i for i, layer in enumerate(base.layer_structure.arr) if layer.is_signal
]
pins_of: dict[int, list] = {}
for pin in base.get_pins():
for net in pin.net_nos:
pins_of.setdefault(net, []).append(pin.location)
context = 2 * (route_args["trace_width"] + route_args["clearance"]) + 2 * via_half + (
route_args.get("edge_clearance") or 0
)
args = dict(route_args)
args["via_cost"] = float(route_args.get("via_cost", 10.0)) * via_cost_factor
changed = False
for net in todo:
if budget_s is not None and time.monotonic() - started >= budget_s:
break
old_vias = len(set(copper[net][1]))
window = _net_box(copper[net], pins_of.get(net, []), margin)
if window is None:
continue
before = _open(f for f in failed if f[0] == net)
view = IntBox(window.ll.x - context, window.ll.y - context,
window.ur.x + context, window.ur.y + context)
keep = set(copper) - {net}
board = _window_board(base, base_items, view, {net}, copper, keep, half,
default_half, via_half, via_drill, layers, via_name)
sub = route_board_exact(
board, **args, resolution=resolution, only_nets=frozenset({net}), bounds=window,
).result
after = _open(f for f in sub.failed if f[0] == net)
new = (sub.wires.get(net, []), sub.vias.get(net, []))
if len(after) > len(before) or len(set(new[1])) >= old_vias:
continue
# the board left out what lies away from the box, so copper reaching
# out of it was never checked against that
if (new[0] or new[1]) and not _inside(new, window):
continue
copper[net] = (list(new[0]), list(new[1]))
half.pop(net, None)
if net in sub.net_half:
half[net] = sub.net_half[net]
failed = [f for f in failed if f[0] != net] + [f for f in sub.failed if f[0] == net]
changed = True
if not changed:
return result
out = RouteResult(default_half)
for net, (wires, vias) in copper.items():
for layer, path in wires:
out.add_wire(net, layer, path)
for location in dict.fromkeys(vias):
out.add_via(net, location)
out.failed = failed
out.unrouted = len(_open(failed))
out.net_half = half
out.narrowed = list(result.narrowed)
return out
+248
View File
@@ -0,0 +1,248 @@
"""Window re-route: a last stage for the connections still unrouted.
Around each stuck connection a window is cut: the box of its two end pins
plus a margin. Every net whose routed copper lies wholly inside it is
ripped; everything else stays, as fixed copper. The window is then routed
again on its own, on a finer grid than the whole board can afford, the
stuck connection's net and the ripped nets only. The result is kept only
if fewer connections are left unrouted than before; otherwise the board is
as it was. Each round doubles the margin for the connections still stuck.
It is a last stage, so it is kept cheap: a window's board holds only what
the window needs (every pin and piece of copper of the nets it reroutes,
so their connectivity is unchanged, and of the other items only those near
the window), the smallest windows go first, at most ``max_windows`` run per
round, and no new window starts once ``budget_s`` seconds are spent.
What makes it differ from re-running the same search near the failure: the
finer grid finds gaps the board's grid steps over, and the ripped nets go in
again in a new order around the stuck one. A finer grid on the whole board
costs routes elsewhere (its cells are slower and its order changes); inside
a small window it only ever replaces what it can improve.
"""
from __future__ import annotations
import time
from typing import Any
from rpmroute.board import BasicBoard, build_board
from rpmroute.board.items import ObstacleArea, Pin, Trace, Via
from rpmroute.dsn import DsnBoard
from rpmroute.geometry import IntBox, IntPoint
from .exact_router import route_board_exact
from .grid_router import RouteResult
Copper = tuple[list[tuple[int, list[IntPoint]]], list[IntPoint]]
def _pin_labels(board) -> dict[tuple[int, str], IntPoint]:
"""Each pin's location by (net, label), the label a failure names it by."""
found: dict[tuple[int, str], IntPoint] = {}
for pin in board.get_pins():
for net in pin.net_nos:
found.setdefault((net, f"{pin.component_ref}-{pin.name}"), pin.location)
return found
def _end_point(labels, net: int, label: str) -> IntPoint | None:
"""Where a failure's end is: the first pin its label names."""
return labels.get((net, label.split("/")[0]))
def _inside(copper: Copper, window: IntBox) -> bool:
wires, vias = copper
points = [p for _layer, path in wires for p in path] + list(vias)
return bool(points) and all(
window.ll.x <= p.x <= window.ur.x and window.ll.y <= p.y <= window.ur.y for p in points
)
def _item_box(item) -> IntBox | None:
if isinstance(item, (Pin, Via)):
return item.shape.bounding_box() if item.shape is not None else None
if isinstance(item, ObstacleArea):
return item.bounding_box()
if isinstance(item, Trace) and item.corners:
h = item.half_width
xs, ys = [p.x for p in item.corners], [p.y for p in item.corners]
return IntBox(min(xs) - h, min(ys) - h, max(xs) + h, max(ys) + h)
return None
def _meets(box: IntBox | None, view: IntBox) -> bool:
return box is not None and box.ll.x <= view.ur.x and view.ll.x <= box.ur.x and (
box.ll.y <= view.ur.y and view.ll.y <= box.ur.y
)
def _path_box(path: list[IntPoint], grow: int) -> IntBox:
xs, ys = [p.x for p in path], [p.y for p in path]
return IntBox(min(xs) - grow, min(ys) - grow, max(xs) + grow, max(ys) + grow)
def _window_board(
base: BasicBoard, base_items: list, view: IntBox, affected: set[int],
copper: dict[int, Copper], keep: set[int], half: dict[int, int], default_half: int,
via_half: int, via_drill: int, layers: list[int], via_name: str,
) -> BasicBoard:
"""The board a window is routed on: the base board's items of the nets
being rerouted and those near ``view``, plus the routed copper being kept
(all of an affected net's, so its connectivity is the whole board's, and
of other nets only what is near ``view``), as fixed copper."""
board = BasicBoard(base.layer_structure, base.nets, base.clearance_matrix, base.bounding_box)
board.outline = base.outline
for item, box in base_items:
if (item.net_nos and item.net_nos[0] in affected) or _meets(box, view):
board.insert(item)
for net in keep:
wires, vias = copper.get(net, ([], []))
width = half.get(net, default_half)
mine = net in affected
for layer, path in wires:
if len(path) >= 2 and (mine or _meets(_path_box(path, width), view)):
board.insert(Trace(net_nos=[net], fixed=True, layer=layer, half_width=width, corners=list(path)))
for location in dict.fromkeys(vias):
shape = IntBox(location.x - via_half, location.y - via_half,
location.x + via_half, location.y + via_half)
if mine or _meets(shape, view):
board.insert(Via(
net_nos=[net], fixed=True, padstack_name=via_name, drill=via_drill,
location=location, layers=list(layers), shape=shape,
))
return board
def _open(failed) -> list:
"""Failures that are real opens, not connections left to a zone fill."""
return [f for f in failed if not (len(f) > 3 and f[3])]
def window_reroute(
dsn: DsnBoard,
result: RouteResult,
route_args: dict[str, Any],
*,
rounds: int,
resolution: int,
margin: int,
via_half: int,
via_drill: int,
via_name: str,
budget_s: float | None = None,
max_windows: int = 40,
) -> RouteResult:
"""Re-route a window around each still-failing connection; keep only gains.
``route_args`` are the exact engine's settings for the whole board (width,
clearance, layers, shove, ...); the window runs them at ``resolution``.
``margin`` is the first round's window margin in board units. No new
window starts once ``budget_s`` seconds have gone by (None: no limit),
and at most ``max_windows`` run per round."""
started = time.monotonic()
if rounds < 1 or not _open(result.failed):
return result
default_half = result.half_width
copper: dict[int, Copper] = {
net: (list(result.wires.get(net, [])), list(result.vias.get(net, [])))
for net in set(result.wires) | set(result.vias)
}
half = dict(result.net_half)
failed = list(result.failed)
base = build_board(dsn)
base_items = [(item, _item_box(item)) for item in base.get_items()]
layers = route_args.get("layers") or [
i for i, layer in enumerate(base.layer_structure.arr) if layer.is_signal
]
labels = _pin_labels(base)
# the copper a window's routing can feel from outside it
context = 2 * (route_args["trace_width"] + route_args["clearance"]) + 2 * via_half + (
route_args.get("edge_clearance") or 0
)
def window_of(entry, reach: int) -> IntBox | None:
ends = [_end_point(labels, entry[0], label) for label in entry[1:3]]
ends = [p for p in ends if p is not None]
if not ends:
return None
return IntBox(
min(p.x for p in ends) - reach, min(p.y for p in ends) - reach,
max(p.x for p in ends) + reach, max(p.y for p in ends) + reach,
)
def area(box: IntBox | None) -> float:
return float("inf") if box is None else (box.ur.x - box.ll.x) * (box.ur.y - box.ll.y)
changed = out_of_time = False
for rnd in range(rounds):
reach = margin * (2 ** rnd)
# the cheap wins first: the smallest windows
todo = sorted(_open(list(failed)), key=lambda f: area(window_of(f, reach)))
for entry in todo[:max(int(max_windows), 1)]:
if budget_s is not None and time.monotonic() - started >= budget_s:
out_of_time = True
break
if entry not in failed:
continue # an earlier window routed it
net = entry[0]
window = window_of(entry, reach)
if window is None:
continue
victims = {n for n, c in copper.items() if _inside(c, window)}
affected = victims | {net}
before = _open(f for f in failed if f[0] in affected)
keep = set(copper) - victims
view = IntBox(window.ll.x - context, window.ll.y - context,
window.ur.x + context, window.ur.y + context)
board = _window_board(base, base_items, view, affected, copper, keep, half,
default_half, via_half, via_drill, layers, via_name)
sub = route_board_exact(
board, **route_args, resolution=resolution,
only_nets=frozenset(affected), bounds=window,
route_first=frozenset((f[0], f[1], f[2]) for f in before),
).result
after = _open(f for f in sub.failed if f[0] in affected)
if len(after) >= len(before):
continue
# the window board left out what lies away from it, so copper
# reaching out of the window was never checked against it
if any(not _inside((sub.wires.get(n, []), sub.vias.get(n, [])), window)
for n in affected if sub.wires.get(n) or sub.vias.get(n)):
continue
# a net keeping some of its copper is written at one width: the
# window's new copper has to have gone in at that width too
if any(
n not in victims and copper.get(n) and (sub.wires.get(n) or sub.vias.get(n))
and sub.net_half.get(n, default_half) != half.get(n, default_half)
for n in affected
):
continue
for n in affected:
kept_wires, kept_vias = copper.get(n, ([], [])) if n not in victims else ([], [])
copper[n] = (kept_wires + sub.wires.get(n, []), kept_vias + sub.vias.get(n, []))
if n in victims:
half.pop(n, None)
if n in sub.net_half:
half[n] = sub.net_half[n]
failed = [f for f in failed if f[0] not in affected] + [
f for f in sub.failed if f[0] in affected
]
changed = True
if out_of_time or not _open(failed):
break
if not changed:
return result
out = RouteResult(default_half)
for net, (wires, vias) in copper.items():
for layer, path in wires:
out.add_wire(net, layer, path)
for location in dict.fromkeys(vias):
out.add_via(net, location)
out.failed = failed
out.unrouted = len(_open(failed))
out.net_half = half
out.narrowed = list(result.narrowed)
return out
@@ -1,9 +1,9 @@
"""Specctra SES (session) writing for freeroute. """Specctra SES (session) writing for rpmroute.
Public API:: Public API::
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.ses import write_ses, RoutingResult, RoutedWire, RoutedVia from rpmroute.ses import write_ses, RoutingResult, RoutedWire, RoutedVia
board = parse_dsn(dsn_text) board = parse_dsn(dsn_text)
ses_text = write_ses(board) # valid no-op session ses_text = write_ses(board) # valid no-op session
@@ -1,8 +1,8 @@
"""Specctra SES session-file writer. """Specctra SES session-file writer.
Ports the write path of FreeRouting's ``io/specctra/SesWriter.java`` to operate Ports the write path of FreeRouting's ``io/specctra/SesWriter.java`` to operate
on this project's parsed :class:`~freeroute.dsn.model.DsnBoard` plus an on this project's parsed :class:`~rpmroute.dsn.model.DsnBoard` plus an
in-memory :class:`~freeroute.ses.model.RoutingResult`. The emitted structure is:: in-memory :class:`~rpmroute.ses.model.RoutingResult`. The emitted structure is::
(session <name> (session <name>
(base_design <name>) (base_design <name>)
@@ -30,8 +30,8 @@ from __future__ import annotations
import math import math
from freeroute.dsn.model import DsnBoard from rpmroute.dsn.model import DsnBoard
from freeroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape from rpmroute.dsn.shapes import Circle, Path, Polygon, Rectangle, Shape
from .indent import Identifier, IndentWriter from .indent import Identifier, IndentWriter
from .model import RoutedNet, RoutedVia, RoutedWire, RoutingResult from .model import RoutedNet, RoutedVia, RoutedWire, RoutingResult
+1 -1
View File
@@ -2,7 +2,7 @@
from __future__ import annotations from __future__ import annotations
from freeroute.board import ( from rpmroute.board import (
ClearanceMatrix, ClearanceMatrix,
CoordinateTransform, CoordinateTransform,
Layer, Layer,
+6 -6
View File
@@ -15,9 +15,9 @@ import sys
import pytest import pytest
from freeroute.board import BasicBoard, ObstacleArea, Pin, build_board from rpmroute.board import BasicBoard, ObstacleArea, Pin, build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.geometry import IntPoint from rpmroute.geometry import IntPoint
sys.path.insert(0, str(Path(__file__).resolve().parent.parent)) sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -184,7 +184,7 @@ def test_place_keepout_does_not_block_routing():
def test_grid_router_leaves_the_interior_of_a_ring_keepout_open(): def test_grid_router_leaves_the_interior_of_a_ring_keepout_open():
from freeroute.route.pipeline import route_dsn_board from rpmroute.route.pipeline import route_dsn_board
ring_only = "\n".join( ring_only = "\n".join(
line for line in _RING_DSN.splitlines() if "wire_keepout" not in line line for line in _RING_DSN.splitlines() if "wire_keepout" not in line
@@ -251,7 +251,7 @@ def test_oval_pad_keeps_its_width():
def test_via_size_comes_from_the_via_padstack(): def test_via_size_comes_from_the_via_padstack():
from freeroute.route.pipeline import _via_half_board from rpmroute.route.pipeline import _via_half_board
assert _via_half_board(parse_dsn(_PAD_DSN), 10) == 3000 # 0.6 mm via, board units assert _via_half_board(parse_dsn(_PAD_DSN), 10) == 3000 # 0.6 mm via, board units
@@ -279,7 +279,7 @@ def test_a_keepout_named_rule_area_takes_no_clearance():
def _route_channel(name): def _route_channel(name):
from freeroute.route.pipeline import build_exact_routing_result from rpmroute.route.pipeline import build_exact_routing_result
return build_exact_routing_result(parse_dsn(_CHANNEL_DSN.format(name=name)), resolution=2) return build_exact_routing_result(parse_dsn(_CHANNEL_DSN.format(name=name)), resolution=2)
+2 -2
View File
@@ -2,8 +2,8 @@
from __future__ import annotations from __future__ import annotations
from freeroute.board import ShapeSearchTree, TreeShape from rpmroute.board import ShapeSearchTree, TreeShape
from freeroute.geometry import IntBox from rpmroute.geometry import IntBox
def shape(owner, net, layer, box, routed=False): def shape(owner, net, layer, box, routed=False):
+4 -4
View File
@@ -6,10 +6,10 @@ from pathlib import Path
import pytest import pytest
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.reader import DsnParseError from rpmroute.dsn.reader import DsnParseError
from freeroute.dsn.shapes import Circle, Rectangle from rpmroute.dsn.shapes import Circle, Rectangle
from freeroute.dsn.shapes import Path as DsnPath from rpmroute.dsn.shapes import Path as DsnPath
FIXTURES = Path(__file__).parent / "fixtures" FIXTURES = Path(__file__).parent / "fixtures"
+2 -2
View File
@@ -4,8 +4,8 @@ from __future__ import annotations
import pytest import pytest
from freeroute.dsn.sexp import SExp, parse from rpmroute.dsn.sexp import SExp, parse
from freeroute.dsn.tokenizer import DsnSyntaxError, Token from rpmroute.dsn.tokenizer import DsnSyntaxError, Token
def test_parse_simple_head_and_values(): def test_parse_simple_head_and_values():
+2 -2
View File
@@ -2,8 +2,8 @@
from __future__ import annotations from __future__ import annotations
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.dsn.shapes import ( from rpmroute.dsn.shapes import (
Circle, Circle,
Path, Path,
Polygon, Polygon,
+1 -1
View File
@@ -4,7 +4,7 @@ from __future__ import annotations
import pytest import pytest
from freeroute.dsn.tokenizer import DsnSyntaxError, TokenKind, tokenize from rpmroute.dsn.tokenizer import DsnSyntaxError, TokenKind, tokenize
def kinds(text: str) -> list[TokenKind]: def kinds(text: str) -> list[TokenKind]:
+1 -1
View File
@@ -6,7 +6,7 @@ containment and degenerate (empty / point / segment) tiles.
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import IntBox, IntPoint, IntVector, RationalPoint from rpmroute.geometry import IntBox, IntPoint, IntVector, RationalPoint
def test_measures(): def test_measures():
+1 -1
View File
@@ -5,7 +5,7 @@ Oracles hand-derived from ``geometry/planar/{Direction,IntDirection}.java``.
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import Direction, IntDirection, IntPoint, IntVector, Side from rpmroute.geometry import Direction, IntDirection, IntPoint, IntVector, Side
def test_normalized_direction_reduces_by_gcd(): def test_normalized_direction_reduces_by_gcd():
+2 -2
View File
@@ -5,7 +5,7 @@ Oracles hand-derived from ``geometry/planar/Line.java``.
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import IntPoint, Line, RationalPoint, Side from rpmroute.geometry import IntPoint, Line, RationalPoint, Side
def test_side_of_point(): def test_side_of_point():
@@ -79,7 +79,7 @@ def test_intersection_approx_matches_exact():
def test_translate_and_opposite(): def test_translate_and_opposite():
line = Line.from_coords(0, 0, 4, 0) line = Line.from_coords(0, 0, 4, 0)
assert line.opposite().direction().equals(line.direction()) is False assert line.opposite().direction().equals(line.direction()) is False
from freeroute.geometry import IntVector from rpmroute.geometry import IntVector
moved = line.translate_by(IntVector(0, 5)) moved = line.translate_by(IntVector(0, 5))
assert moved.side_of(IntPoint(2, 5)) == Side.COLLINEAR assert moved.side_of(IntPoint(2, 5)) == Side.COLLINEAR
+1 -1
View File
@@ -7,7 +7,7 @@ import random
import pytest import pytest
from freeroute.geometry import IntBox, IntPoint, ceil_sqrt2, overlaps_2d, segment_octagon from rpmroute.geometry import IntBox, IntPoint, ceil_sqrt2, overlaps_2d, segment_octagon
@pytest.mark.parametrize("r", [0, 1, 2, 3, 1000, 2000, 3000, 12345, 999999]) @pytest.mark.parametrize("r", [0, 1, 2, 3, 1000, 2000, 3000, 12345, 999999])
+2 -2
View File
@@ -8,7 +8,7 @@ Java ``long``, and rational equality.
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import ( from rpmroute.geometry import (
IntPoint, IntPoint,
IntVector, IntVector,
RationalPoint, RationalPoint,
@@ -139,7 +139,7 @@ def test_rational_point_infinite():
def test_rational_point_contained_in_box_exact(): def test_rational_point_contained_in_box_exact():
from freeroute.geometry import IntBox from rpmroute.geometry import IntBox
box = IntBox(0, 0, 2, 2) box = IntBox(0, 0, 2, 2)
assert RationalPoint(3, 2, 2).is_contained_in(box) # (1.5, 1.0) inside assert RationalPoint(3, 2, 2).is_contained_in(box) # (1.5, 1.0) inside
+3 -3
View File
@@ -13,9 +13,9 @@ from __future__ import annotations
import pytest import pytest
from freeroute.geometry import IntPoint, Side from rpmroute.geometry import IntPoint, Side
from freeroute.geometry.polygon import Polygon from rpmroute.geometry.polygon import Polygon
from freeroute.geometry.polygon_shape import PolygonShape from rpmroute.geometry.polygon_shape import PolygonShape
def pts(*coords): def pts(*coords):
+1 -1
View File
@@ -2,7 +2,7 @@
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import ( from rpmroute.geometry import (
IntBox, IntBox,
IntPoint, IntPoint,
Polyline, Polyline,
+2 -2
View File
@@ -16,7 +16,7 @@ Source: ``geometry/planar/{TileShape,Simplex}.java``.
from __future__ import annotations from __future__ import annotations
from freeroute.geometry import IntBox, IntPoint, Line, Side, Simplex from rpmroute.geometry import IntBox, IntPoint, Line, Side, Simplex
def _grid(lo: int, hi: int): def _grid(lo: int, hi: int):
@@ -162,7 +162,7 @@ def test_get_instance_detects_empty_from_opposing_halfplanes():
def test_translate_preserves_shape(): def test_translate_preserves_shape():
tri = right_triangle() tri = right_triangle()
from freeroute.geometry import IntVector from rpmroute.geometry import IntVector
moved = tri.translate_by(IntVector(100, 50)) moved = tri.translate_by(IntVector(100, 50))
for p in _grid(-3, 13): for p in _grid(-3, 13):
+5 -5
View File
@@ -1,8 +1,8 @@
"""FreeRouting JAR oracle for behaviour-level validation. """FreeRouting JAR oracle for behaviour-level validation.
**Dev/test only — not part of the shipped package** (freeroute is Java-free by **Dev/test only — not part of the shipped package** (rpmroute is Java-free by
design). This runs the reference FreeRouting JAR to route a Specctra DSN so that design). This runs the reference FreeRouting JAR to route a Specctra DSN so that
freeroute's own output can be diffed against the reference implementation. There rpmroute's own output can be diffed against the reference implementation. There
are no unit-test oracles for FreeRouting's geometry/router, so the oracle is how are no unit-test oracles for FreeRouting's geometry/router, so the oracle is how
we validate at the behaviour level: same DSN in, compare routed connectivity. we validate at the behaviour level: same DSN in, compare routed connectivity.
@@ -10,7 +10,7 @@ Tests that use this skip automatically when a Java 21+ runtime or the JAR is not
available (e.g. CI without a JVM), so the normal suite stays Java-free. available (e.g. CI without a JVM), so the normal suite stays Java-free.
Overrides: Overrides:
- ``FREEROUTE_ORACLE_JAVA`` — explicit path to a ``java`` binary. - ``RPMROUTE_ORACLE_JAVA`` (or the older ``FREEROUTE_ORACLE_JAVA``) — explicit path to a ``java`` binary.
- ``FREEROUTING_JAR`` — explicit path to a freerouting JAR. - ``FREEROUTING_JAR`` — explicit path to a freerouting JAR.
""" """
@@ -27,7 +27,7 @@ import tempfile
import pytest import pytest
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
_MIN_JAVA_MAJOR = 21 _MIN_JAVA_MAJOR = 21
_REPO_ROOT = Path(__file__).resolve().parents[1] _REPO_ROOT = Path(__file__).resolve().parents[1]
@@ -60,7 +60,7 @@ def _java_major(java: str) -> int:
def find_java() -> str | None: def find_java() -> str | None:
"""Return a path to a Java >= 21 runtime, or None.""" """Return a path to a Java >= 21 runtime, or None."""
candidates: list[str] = [] candidates: list[str] = []
override = os.environ.get("FREEROUTE_ORACLE_JAVA") override = os.environ.get("RPMROUTE_ORACLE_JAVA") or os.environ.get("FREEROUTE_ORACLE_JAVA")
if override: if override:
candidates.append(override) candidates.append(override)
java_home = os.environ.get("JAVA_HOME") java_home = os.environ.get("JAVA_HOME")
+113
View File
@@ -0,0 +1,113 @@
"""Pins of a fine-pitch part turned off the grid axes leave along their pads.
A QFN at 45 degrees has no straight exit: every horizontal or vertical step
from a pin passes its neighbours closer than the clearance (0.35 mm away on
each axis at 0.5 mm pitch). The grid leaves along the pad's own axis first,
past the pin row, and the exact engine checks that slanted leg on its exact
copper. Found on th-eda's lift ESC, where a QFN-24 at 45 degrees left 15
connections unroutable on an empty board.
"""
from __future__ import annotations
import math
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntPoint, overlaps_2d, segment_slab
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import (
_rule_clearance_dsn,
_rule_width_dsn,
_via_half_board,
build_exact_routing_result,
)
def _qfn_side_dsn(rotation: float) -> str:
"""Two rows of five 0.25 x 0.8 mm pads at 0.5 mm pitch (one side of a
QFN and its opposite side), turned by ``rotation``; each pin of the top
row is its own net, routed to a pad 4.5 mm out, the pads fanned 1.5 mm
apart."""
cx, cy = 100000, -100000
t = math.radians(rotation)
out = (-math.sin(t), math.cos(t)) # the pads' outward axis after turning
along = (math.cos(t), math.sin(t)) # the pin row
pins, targets, nets = [], [], []
for i in range(5):
x = -1000 + 500 * i
pins += [f"(pin P {i + 1} {x} 1000)", f"(pin P {i + 6} {x} -1000)"]
px = cx + x * math.cos(t) - 1000 * math.sin(t)
py = cy + x * math.sin(t) + 1000 * math.cos(t)
spread = 1500 * (i - 2) - x # fan the far pads out to 1.5 mm apart
tx = px + 4500 * out[0] + spread * along[0]
ty = py + 4500 * out[1] + spread * along[1]
targets.append(f"(place T{i + 1} {round(tx)} {round(ty)} front 0)")
nets.append(f"(net N{i} (pins U1-{i + 1} T{i + 1}-1))")
return f"""(pcb qfn (parser) (resolution um 10) (unit um)
(structure
(layer F.Cu (type signal)) (layer B.Cu (type signal))
(boundary (path pcb 0 115000 -115000 85000 -115000 85000 -85000 115000 -85000
115000 -115000))
(via "Via[0-1]_450:200_um")
(rule (width 150) (clearance 150)))
(placement
(component Q (place U1 {cx} {cy} front {rotation}))
(component T {" ".join(targets)}))
(library
(image Q {" ".join(pins)})
(image T (pin t 1 0 0))
(padstack P (shape (rect F.Cu -125 -400 125 400)) (attach off))
(padstack t (shape (rect F.Cu -300 -300 300 300)) (attach off))
(padstack "Via[0-1]_450:200_um" (shape (circle F.Cu 450)) (shape (circle B.Cu 450))
(attach off)))
(network {" ".join(nets)}))"""
@pytest.mark.parametrize("rotation", [45, 30, -45])
def test_a_turned_fine_pitch_part_gets_its_pins_out(rotation):
result = build_exact_routing_result(parse_dsn(_qfn_side_dsn(rotation)), resolution=2, shove=True)
assert result.unrouted == []
def test_the_exit_runs_along_the_pad_axis_and_clears_the_neighbours():
dsn = parse_dsn(_qfn_side_dsn(45))
s = dsn.resolution.value
board = build_board(dsn)
router = GridRouter(
board,
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
via_half=_via_half_board(dsn, s),
orthogonal=True,
)
pins = {p.name: p for p in board.get_pins() if p.component_ref == "U1"}
pin = pins["3"]
exit_point = router._axis_exit(pin)
assert exit_point is not None
dx, dy = exit_point.x - pin.location.x, exit_point.y - pin.location.y
assert abs(abs(dx) - abs(dy)) <= 2 # along the 45-degree axis
leg = segment_slab(pin.location, exit_point, router.half_width + router.clearance)
for name in ("2", "4"):
assert not overlaps_2d(leg, pins[name].shape)
def test_a_pad_on_the_grid_axes_keeps_the_usual_exits():
dsn = parse_dsn(_qfn_side_dsn(0))
s = dsn.resolution.value
board = build_board(dsn)
router = GridRouter(board, trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), via_half=_via_half_board(dsn, s))
pin = next(p for p in board.get_pins() if p.component_ref == "U1" and p.name == "3")
assert router._axis_exit(pin) is None
def test_a_slanted_slab_is_tight_where_a_bounding_box_is_not():
slab = segment_slab(IntPoint(0, 0), IntPoint(10000, 10000), 750)
# a point beside the diagonal but inside its bounding box
from rpmroute.geometry import IntBox
assert not overlaps_2d(slab, IntBox(8000, 0, 8100, 100))
assert overlaps_2d(slab, IntBox(4900, 4900, 5100, 5100))
+6 -6
View File
@@ -16,11 +16,11 @@ from pathlib import Path
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.geometry import IntBox, IntPoint, overlaps_2d, segment_octagon from rpmroute.geometry import IntBox, IntPoint, overlaps_2d, segment_octagon
from freeroute.route import route, route_dsn_board_exact from rpmroute.route import route, route_dsn_board_exact
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures" FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
DIAGONAL_WIN = FIXTURES / "diagonal_win.dsn" DIAGONAL_WIN = FIXTURES / "diagonal_win.dsn"
@@ -55,7 +55,7 @@ def _pins_by_net(fixture):
def _rule_clearance_board(fixture): def _rule_clearance_board(fixture):
from freeroute.route.pipeline import _rule_clearance_dsn from rpmroute.route.pipeline import _rule_clearance_dsn
dsn = parse_dsn(fixture.read_text()) dsn = parse_dsn(fixture.read_text())
return round(_rule_clearance_dsn(dsn) * max(dsn.resolution.value, 1)) return round(_rule_clearance_dsn(dsn) * max(dsn.resolution.value, 1))
+6 -6
View File
@@ -15,12 +15,12 @@ import sys
import pytest import pytest
from freeroute.board import ShapeSearchTree, TreeShape, build_board from rpmroute.board import ShapeSearchTree, TreeShape, build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.geometry import IntBox, Polyline, PolylineShape from rpmroute.geometry import IntBox, Polyline, PolylineShape
from freeroute.route import route, route_dsn_board, route_dsn_board_exact from rpmroute.route import route, route_dsn_board, route_dsn_board_exact
from freeroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
sys.path.insert(0, str(Path(__file__).resolve().parent.parent)) sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
+5 -5
View File
@@ -2,9 +2,9 @@
from __future__ import annotations from __future__ import annotations
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.route.pipeline import route_dsn_board_exact from rpmroute.route.pipeline import route_dsn_board_exact
_DSN = """(pcb wired (parser) (resolution um 10) (unit um) _DSN = """(pcb wired (parser) (resolution um 10) (unit um)
(structure (structure
@@ -95,9 +95,9 @@ def test_a_fanned_out_signal_is_routed_from_its_via():
def test_the_session_never_repeats_copper_already_on_the_board(): def test_the_session_never_repeats_copper_already_on_the_board():
# the JAR writes the DSN's wiring back into its session, and an applier # the JAR writes the DSN's wiring back into its session, and an applier
# then adds it a second time on top of itself; freeroute writes only # then adds it a second time on top of itself; rpmroute writes only
# what it routed # what it routed
from freeroute.route.pipeline import build_exact_routing_result from rpmroute.route.pipeline import build_exact_routing_result
fixed_vias = {(5000.0, -11500.0), (10000.0, -11500.0)} fixed_vias = {(5000.0, -11500.0), (10000.0, -11500.0)}
fixed_paths = {(5000.0, -10000.0, 5000.0, -11500.0), (10000.0, -10000.0, 10000.0, -11500.0), fixed_paths = {(5000.0, -10000.0, 5000.0, -11500.0), (10000.0, -10000.0, 10000.0, -11500.0),
+63 -6
View File
@@ -12,11 +12,11 @@ import math
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.geometry import IntBox, Simplex from rpmroute.geometry import IntBox, Simplex
from freeroute.route.grid_router import GridRouter from rpmroute.route.grid_router import GridRouter
from freeroute.route.pipeline import ( from rpmroute.route.pipeline import (
_rule_clearance_dsn, _rule_clearance_dsn,
_rule_width_dsn, _rule_width_dsn,
_via_half_board, _via_half_board,
@@ -143,11 +143,48 @@ def test_a_shared_via_keeps_its_footprint_when_one_user_is_ripped():
router._rip(first) router._rip(first)
assert second.routed and via in second.via_cells assert second.routed and via in second.via_cells
assert all(router._via_owner.get(c) == second.index for c in footprint) assert all(router._via_claims.get(c) == [second.index] for c in footprint)
# another net still keeps its distance from the via that is left # another net still keeps its distance from the via that is left
assert all(router._enter_cost_base(c, 0, sig.net_no, False, conns) is None for c in footprint) assert all(router._enter_cost_base(c, 0, sig.net_no, False, conns) is None for c in footprint)
def test_a_route_through_a_shared_via_rips_every_user():
"""Two connections of a net share a via. Another net routed through it
in rip-up mode has to rip both, or the one left keeps its via under the
new trace and the exact check throws one of them out."""
dsn = parse_dsn(_SHARED_VIA)
s = dsn.resolution.value
router = GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
via_half=_via_half_board(dsn, s),
)
conns = router._conns = router._build_connections()
gnd = [c for c in conns if len({c.a.component_ref, c.b.component_ref} & {"G1", "G2", "G3"})]
sig = next(c for c in conns if c not in gnd)
first, second = gnd
g3 = router._cell_of(next(p for p in router.board.get_pins() if p.component_ref == "G3").location)
via = (g3[0] - 10, g3[1])
def through_via(conn):
a, b = router._cell_of(conn.a.location), router._cell_of(conn.b.location)
return _line(a, via, 0) + _line(via, b, 1)
router._commit(first, through_via(first))
router._commit(second, through_via(second))
# the via's copper alone: footprint cells no trace or trace halo covers
crossing = [
node
for c in router._via_cells(via)
for node in ((*c, 0), (*c, 1))
if node not in router._cell_owner and node not in router._halo
]
assert crossing
assert router._crossed_owners(crossing, sig.net_no, conns) == {first.index, second.index}
# --- a wider net class -------------------------------------------------------- # --- a wider net class --------------------------------------------------------
_WIDE = """(pcb wide (parser) (resolution um 10) (unit um) _WIDE = """(pcb wide (parser) (resolution um 10) (unit um)
@@ -225,3 +262,23 @@ def test_a_pad_cell_check_uses_the_rotated_outline():
c = router._cell_center(cell) c = router._cell_center(cell)
square = IntBox(c.x - margin, c.y - margin, c.x + margin, c.y + margin) square = IntBox(c.x - margin, c.y - margin, c.x + margin, c.y + margin)
assert oval.shape.intersection(square).dimension() != 2 assert oval.shape.intersection(square).dimension() != 2
def test_a_via_by_a_chamfered_corner_is_judged_round():
"""The grid keeps a via's centre its radius plus the edge clearance from
the outline. The exact check used the via's square, whose corner reaches
past a 45-degree chamfer where the round via does not."""
from rpmroute.board.outline import BoardOutline
from rpmroute.geometry import IntBox, IntPoint
from rpmroute.route.exact_router import _inside_outline
# a 10 mm square with its lower-left corner cut at 45 degrees
outline = BoardOutline([IntPoint(*p) for p in
[(30, 0), (100, 0), (100, 100), (0, 100), (0, 30)]])
half, edge = 4, 1
via = IntPoint(19, 20) # its centre 6.4 from the chamfer x + y = 30
square = IntBox(via.x - half, via.y - half, via.x + half, via.y + half)
assert not outline.box_clear(square, edge) # the square's corner: 0.7 away
assert _inside_outline(outline, [], [via], half + edge, edge)
# 4.2 from the chamfer: the round via itself is too close
assert not _inside_outline(outline, [], [IntPoint(18, 18)], half + edge, edge)
+65
View File
@@ -0,0 +1,65 @@
"""--negotiate: PathFinder-style rounds on the empty board before routing."""
from __future__ import annotations
from pathlib import Path
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
def _router(name, negotiate):
dsn = parse_dsn((FIXTURES / name).read_text())
s = dsn.resolution.value
return GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
negotiate=negotiate,
)
def test_negotiation_leaves_the_board_empty_and_the_ends_as_they_were():
router = _router("true_density.dsn", 3)
conns = router._conns = router._build_connections()
ends = [(c.a_end, c.b_end) for c in conns]
router._negotiate(list(conns), conns)
assert router._history # a dense board has contested cells
assert not router._cell_owner and not router._halo and not router._via_claims
assert not any(c.routed for c in conns)
assert [(c.a_end, c.b_end) for c in conns] == ends
assert router._present is None
def test_sharing_is_priced_only_for_other_nets():
router = _router("true_density.dsn", 1)
node = (3, 4, 0)
router._history[node] = 2.0
router._present, router._present_cost = {node: {7: 1, 9: 2}}, 0.5
assert router._congestion(node, 7) == pytest.approx(2.5) # one other net
assert router._congestion(node, 5) == pytest.approx(3.0) # two other nets
router._present = None
assert router._congestion(node, 5) == pytest.approx(2.0) # history only, after
@pytest.mark.parametrize("name", ["ripup_needed.dsn", "true_density.dsn", "kicad_routable.dsn"])
def test_negotiated_routing_keeps_the_occupancy_honest(name):
"""Only routed connections hold cells afterwards, as without negotiation."""
router = _router(name, 3)
router.route()
conns = router._conns
assert all(conns[i].routed for i in router._cell_owner.values())
assert all(conns[i].routed for claims in router._halo.values() for i in claims)
def test_option_reaches_the_router_and_is_off_by_default():
text = (FIXTURES / "kicad_routable.dsn").read_text()
plain, _, _ = route_dsn_board(parse_dsn(text))
again, _, _ = route_dsn_board(parse_dsn(text), negotiate=0)
assert plain.unrouted == again.unrouted
+2 -2
View File
@@ -2,8 +2,8 @@
from __future__ import annotations from __future__ import annotations
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.route.pipeline import build_exact_routing_result from rpmroute.route.pipeline import build_exact_routing_result
_BOARD = """(pcb widths (parser) (resolution um 10) (unit um) _BOARD = """(pcb widths (parser) (resolution um 10) (unit um)
(structure (structure
+2 -2
View File
@@ -4,8 +4,8 @@ from __future__ import annotations
from pathlib import Path from pathlib import Path
from freeroute.cli import main from rpmroute.cli import main
from freeroute.route.orders import ( from rpmroute.route.orders import (
best_of_orders, best_of_orders,
candidate_seeds, candidate_seeds,
promote_failures, promote_failures,
+8 -8
View File
@@ -6,9 +6,9 @@ import math
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.route.pipeline import route_dsn_board_exact from rpmroute.route.pipeline import route_dsn_board_exact
# 20 x 20 mm board whose corners are rounded with a 3 mm radius, as polylines # 20 x 20 mm board whose corners are rounded with a 3 mm radius, as polylines
_R = 3000.0 _R = 3000.0
@@ -70,7 +70,7 @@ def test_every_pin_of_a_half_millimetre_pitch_row_escapes(resolution):
def test_resolution_one_has_no_halo_so_the_grid_is_unchanged(): def test_resolution_one_has_no_halo_so_the_grid_is_unchanged():
from freeroute.route.grid_router import GridRouter from rpmroute.route.grid_router import GridRouter
board = build_board(parse_dsn(_dsn("", ""))) board = build_board(parse_dsn(_dsn("", "")))
assert GridRouter(board, trace_width=2500, clearance=1500)._halo_offsets == [] assert GridRouter(board, trace_width=2500, clearance=1500)._halo_offsets == []
@@ -101,7 +101,7 @@ def test_heuristic_weight_bounds_route_length():
# --- copper zones (DSN planes) ----------------------------------------------- # --- copper zones (DSN planes) -----------------------------------------------
# rc4 power stage: pads inside "keep router off" pours connect through the pour, # rc4 power stage: pads inside "keep router off" pours connect through the pour,
# and freeroute, not knowing zones, dropped every such connection. # and rpmroute, not knowing zones, dropped every such connection.
_ZONE = "(plane N (polygon F.Cu 0 4000 -4000 10000 -4000 10000 -10000 4000 -10000 4000 -4000))" _ZONE = "(plane N (polygon F.Cu 0 4000 -4000 10000 -4000 10000 -10000 4000 -10000 4000 -4000))"
_NO_TRACKS = "(wire_keepout \"pour\" (polygon F.Cu 0 4000 -4000 10000 -4000 10000 -10000 4000 -10000))" _NO_TRACKS = "(wire_keepout \"pour\" (polygon F.Cu 0 4000 -4000 10000 -4000 10000 -10000 4000 -10000))"
@@ -121,7 +121,7 @@ def test_planes_are_read_and_are_not_obstacles():
def test_pads_in_one_zone_need_no_route_between_them(): def test_pads_in_one_zone_need_no_route_between_them():
from freeroute.route.grid_router import _connected_groups from rpmroute.route.grid_router import _connected_groups
board = build_board(_zone_board()) board = build_board(_zone_board())
pins = sorted(board.get_pins(), key=lambda p: p.component_ref) pins = sorted(board.get_pins(), key=lambda p: p.component_ref)
@@ -155,7 +155,7 @@ def test_a_pour_other_nets_can_cross_is_not_trusted_to_connect():
def test_cli_names_the_connections_it_could_not_route(tmp_path, capsys): def test_cli_names_the_connections_it_could_not_route(tmp_path, capsys):
# a keepout wall across the board on both layers: A and B cannot be joined # a keepout wall across the board on both layers: A and B cannot be joined
from freeroute.cli import main from rpmroute.cli import main
wall = " ".join( wall = " ".join(
f"(keepout \"wall\" (polygon {layer} 0 9000 1000 11000 1000 11000 -21000 9000 -21000))" f"(keepout \"wall\" (polygon {layer} 0 9000 1000 11000 1000 11000 -21000 9000 -21000))"
@@ -218,7 +218,7 @@ def test_a_pad_outside_the_plane_routes_to_it():
def test_a_through_hole_pad_inside_a_plane_needs_no_route(): def test_a_through_hole_pad_inside_a_plane_needs_no_route():
from freeroute.route.grid_router import _connected_groups from rpmroute.route.grid_router import _connected_groups
board = build_board(parse_dsn(_four_layer_dsn())) board = build_board(parse_dsn(_four_layer_dsn()))
plane = [z for z in board.get_conduction_areas() if z.name == "GND"] plane = [z for z in board.get_conduction_areas() if z.name == "GND"]
+123
View File
@@ -0,0 +1,123 @@
"""Via reduction: each net with vias is routed again with vias made dear,
kept only when it fails nothing new and has fewer vias."""
from __future__ import annotations
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntPoint
from rpmroute.route.grid_router import RouteResult
from rpmroute.route.pipeline import (
_rule_clearance_dsn,
_rule_width_dsn,
_via_half_board,
route_dsn_board_exact,
)
from rpmroute.route.vias import reduce_vias
VIA = "Via[0-1]_600:300_um"
def _board(second_on_bottom: bool = False) -> str:
"""Two pads 14 mm apart on an empty two-layer board; the second on the
bottom layer when ``second_on_bottom``."""
p2_stack = "Bot_Pad" if second_on_bottom else "Top_Pad"
return f"""(pcb "vias.dsn"
(parser (string_quote ") (space_in_quoted_tokens on) (host_cad "t") (host_version "1"))
(resolution um 10)
(unit um)
(structure
(layer F.Cu (type signal) (property (index 0)))
(layer B.Cu (type signal) (property (index 1)))
(boundary (path pcb 0 0 0 20000 0 20000 -10000 0 -10000 0 0))
(via "{VIA}")
(rule (width 200) (clearance 200))
)
(library
(padstack Top_Pad (shape (rect F.Cu -300 -300 300 300)) (attach off))
(padstack Bot_Pad (shape (rect B.Cu -300 -300 300 300)) (attach off))
(padstack "{VIA}" (shape (circle F.Cu 600)) (shape (circle B.Cu 600)) (attach off))
(image TOP (pin Top_Pad 1 0 0))
(image SECOND (pin {p2_stack} 1 0 0))
)
(placement
(component TOP (place P1 3000 -5000 front 0))
(component SECOND (place P2 17000 -5000 front 0))
)
(network
(net N (pins P1-1 P2-1))
(class default (rule (width 200) (clearance 200)))
)
(wiring)
)
"""
def _route_args(dsn) -> dict:
scale = max(dsn.resolution.value, 1)
return {
"heuristic_weight": 1.0,
"via_half": _via_half_board(dsn, scale),
"edge_clearance": None,
"trace_width": round(_rule_width_dsn(dsn) * scale),
"clearance": round(_rule_clearance_dsn(dsn) * scale),
"layers": None,
"max_passes": 10,
"rip_up": True,
"shove": False,
"diagonal": False,
"rollback": True,
"tree_nets": True,
"net_widths": {},
"via_drill": None,
"hole_to_hole": 0,
"via_cost": 10.0,
}
def _reduce(text: str, result: RouteResult) -> RouteResult:
dsn = parse_dsn(text)
args = _route_args(dsn)
return reduce_vias(
dsn, result, args, resolution=1, margin=20000,
via_half=args["via_half"], via_drill=2 * args["via_half"], via_name=VIA,
)
def _pins(text: str) -> tuple[IntPoint, IntPoint]:
pins = {p.component_ref: p.location for p in build_board(parse_dsn(text)).get_pins()}
return pins["P1"], pins["P2"]
def test_a_needless_via_pair_is_routed_out():
text = _board()
a, b = _pins(text)
# a detour: down to the bottom layer and back up, for no reason
v1, v2 = IntPoint(a.x + 40000, a.y), IntPoint(b.x - 40000, b.y)
detour = RouteResult(1000)
detour.add_wire(1, 0, [a, v1])
detour.add_via(1, v1)
detour.add_wire(1, 1, [v1, v2])
detour.add_via(1, v2)
detour.add_wire(1, 0, [v2, b])
out = _reduce(text, detour)
assert out.failed == []
assert sum(len(v) for v in out.vias.values()) == 0
assert out.wires.get(1)
def test_a_needed_via_stays():
text = _board(second_on_bottom=True)
exact, _scale, _layers = route_dsn_board_exact(parse_dsn(text), resolution=1)
routed = exact.result
assert routed.failed == []
vias_before = sum(len(set(v)) for v in routed.vias.values())
assert vias_before >= 1
out = _reduce(text, routed)
assert out.failed == []
assert sum(len(set(v)) for v in out.vias.values()) == vias_before
def test_the_flag_runs_the_stage_end_to_end():
exact, _scale, _layers = route_dsn_board_exact(parse_dsn(_board()), resolution=1, reduce_vias=True)
assert exact.result.failed == []
+5 -5
View File
@@ -6,10 +6,10 @@ from pathlib import Path
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.route.grid_router import GridRouter from rpmroute.route.grid_router import GridRouter
from freeroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures" FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
@@ -31,7 +31,7 @@ def test_occupancy_only_holds_routed_connections(name):
router, _ = _routed_router(name) router, _ = _routed_router(name)
conns = router._conns conns = router._conns
assert all(conns[i].routed for i in router._cell_owner.values()) assert all(conns[i].routed for i in router._cell_owner.values())
assert all(conns[i].routed for i in router._via_owner.values()) assert all(conns[i].routed for claims in router._via_claims.values() for i in claims)
assert all(conns[i].routed for claims in router._halo.values() for i in claims) assert all(conns[i].routed for claims in router._halo.values() for i in claims)
+6 -6
View File
@@ -23,11 +23,11 @@ from pathlib import Path
import pytest import pytest
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.geometry import Polyline, PolylineShape from rpmroute.geometry import Polyline, PolylineShape
from freeroute.route import route, route_dsn_board_rooms from rpmroute.route import route, route_dsn_board_rooms
from freeroute.route.pipeline import _rule_clearance_dsn from rpmroute.route.pipeline import _rule_clearance_dsn
FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures" FIXTURES = Path(__file__).resolve().parent.parent / "dsn" / "fixtures"
CHANNEL_PACK = FIXTURES / "channel_pack.dsn" CHANNEL_PACK = FIXTURES / "channel_pack.dsn"
@@ -134,7 +134,7 @@ def test_channel_pack_is_deterministic():
def test_channel_pack_endpoints_stay_on_pads(): def test_channel_pack_endpoints_stay_on_pads():
dsn = parse_dsn(CHANNEL_PACK.read_text()) dsn = parse_dsn(CHANNEL_PACK.read_text())
board_pins: dict[int, set[tuple[int, int]]] = {} board_pins: dict[int, set[tuple[int, int]]] = {}
from freeroute.board import build_board from rpmroute.board import build_board
for pin in build_board(dsn).get_pins(): for pin in build_board(dsn).get_pins():
for net_no in pin.net_nos: for net_no in pin.net_nos:
+6 -6
View File
@@ -13,11 +13,11 @@ import sys
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.geometry import Polyline from rpmroute.geometry import Polyline
from freeroute.route import route, route_dsn_board_exact, route_dsn_board_rooms from rpmroute.route import route, route_dsn_board_exact, route_dsn_board_rooms
sys.path.insert(0, str(Path(__file__).resolve().parent.parent)) sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -31,7 +31,7 @@ WIDE_DOOR = FIXTURES / "rooms_wide_door.dsn"
def _clearance(dsn, scale): def _clearance(dsn, scale):
from freeroute.route.pipeline import _rule_clearance_dsn from rpmroute.route.pipeline import _rule_clearance_dsn
return round(_rule_clearance_dsn(dsn) * scale) return round(_rule_clearance_dsn(dsn) * scale)
+11 -11
View File
@@ -32,12 +32,12 @@ import sys
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.geometry import IntBox, IntPoint, Polyline, PolylineShape from rpmroute.geometry import IntBox, IntPoint, Polyline, PolylineShape
from freeroute.route import route, route_dsn_board_exact, route_dsn_board_rooms from rpmroute.route import route, route_dsn_board_exact, route_dsn_board_rooms
from freeroute.route.pipeline import _rule_clearance_dsn from rpmroute.route.pipeline import _rule_clearance_dsn
def _emitted_drc_violations(result, clearance): def _emitted_drc_violations(result, clearance):
@@ -265,8 +265,8 @@ def test_shove_is_byte_identical_on_foundation_fixtures(fixture):
def test_project_gate_reduces_to_clamp_without_occupancy(): def test_project_gate_reduces_to_clamp_without_occupancy():
from freeroute.board.search_tree import ShapeSearchTree from rpmroute.board.search_tree import ShapeSearchTree
from freeroute.route.room_router import _Door, _edge_gate, _project_gate from rpmroute.route.room_router import _Door, _edge_gate, _project_gate
door = _Door(other=1, kind="edge", lo=IntPoint(0, 100), hi=IntPoint(200, 100)) door = _Door(other=1, kind="edge", lo=IntPoint(0, 100), hi=IntPoint(200, 100))
tree = ShapeSearchTree() tree = ShapeSearchTree()
@@ -277,8 +277,8 @@ def test_project_gate_reduces_to_clamp_without_occupancy():
def test_project_gate_avoids_other_net_copper_on_the_door(): def test_project_gate_avoids_other_net_copper_on_the_door():
from freeroute.board.search_tree import ShapeSearchTree, TreeShape from rpmroute.board.search_tree import ShapeSearchTree, TreeShape
from freeroute.route.room_router import _Door, _project_gate from rpmroute.route.room_router import _Door, _project_gate
door = _Door(other=1, kind="edge", lo=IntPoint(0, 100), hi=IntPoint(200, 100)) door = _Door(other=1, kind="edge", lo=IntPoint(0, 100), hi=IntPoint(200, 100))
tree = ShapeSearchTree() tree = ShapeSearchTree()
@@ -293,7 +293,7 @@ def test_project_gate_avoids_other_net_copper_on_the_door():
def test_free_intervals_splits_around_forbidden_band(): def test_free_intervals_splits_around_forbidden_band():
from freeroute.route.room_router import _best_free_point, _free_intervals from rpmroute.route.room_router import _best_free_point, _free_intervals
free = _free_intervals(0, 200, [(87, 113)]) free = _free_intervals(0, 200, [(87, 113)])
assert free == [(0, 87), (113, 200)] assert free == [(0, 87), (113, 200)]
+8 -8
View File
@@ -16,11 +16,11 @@ import sys
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.route import route, route_dsn_board from rpmroute.route import route, route_dsn_board
from freeroute.ses.writer import ses_scale from rpmroute.ses.writer import ses_scale
sys.path.insert(0, str(Path(__file__).resolve().parent.parent)) sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -287,11 +287,11 @@ def test_connectivity_parity_on_congested_board():
if not HAS_ORACLE: if not HAS_ORACLE:
pytest.skip("FreeRouting oracle unavailable") pytest.skip("FreeRouting oracle unavailable")
our_nets = routed_net_set(route(RIPUP.read_text())) our_nets = routed_net_set(route(RIPUP.read_text()))
assert our_nets == {"NET_A", "NET_B"} # freeroute connects both via rip-up assert our_nets == {"NET_A", "NET_B"} # rpmroute connects both via rip-up
oracle_nets = routed_net_set(route_dsn(RIPUP, max_passes=3, timeout=300)) oracle_nets = routed_net_set(route_dsn(RIPUP, max_passes=3, timeout=300))
if not oracle_nets: if not oracle_nets:
# the reference JAR does not route this synthetic single-signal-layer # the reference JAR does not route this synthetic single-signal-layer
# board (it expects a routing/via layer); freeroute's rip-up connecting # board (it expects a routing/via layer); rpmroute's rip-up connecting
# both nets is already asserted above and by the fast tests. # both nets is already asserted above and by the fast tests.
pytest.skip("reference JAR routed nothing on the synthetic single-layer board") pytest.skip("reference JAR routed nothing on the synthetic single-layer board")
assert oracle_nets <= our_nets # rip-up matches the JAR's connectivity assert oracle_nets <= our_nets # rip-up matches the JAR's connectivity
@@ -306,7 +306,7 @@ def test_connectivity_parity_on_crossing_board():
our_nets = routed_net_set(route(CROSSING.read_text())) our_nets = routed_net_set(route(CROSSING.read_text()))
oracle_nets = routed_net_set(route_dsn(CROSSING, max_passes=3, timeout=300)) oracle_nets = routed_net_set(route_dsn(CROSSING, max_passes=3, timeout=300))
assert oracle_nets, "oracle routed nothing on a routable board" assert oracle_nets, "oracle routed nothing on a routable board"
assert oracle_nets <= our_nets # freeroute connects every net the JAR does assert oracle_nets <= our_nets # rpmroute connects every net the JAR does
@pytest.mark.oracle @pytest.mark.oracle
+5 -5
View File
@@ -17,10 +17,10 @@ import sys
import pytest import pytest
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import parse from rpmroute.dsn.sexp import parse
from freeroute.route import route, route_dsn_board_exact from rpmroute.route import route, route_dsn_board_exact
from freeroute.route.pipeline import _rule_clearance_dsn from rpmroute.route.pipeline import _rule_clearance_dsn
sys.path.insert(0, str(Path(__file__).resolve().parent.parent)) sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
@@ -66,7 +66,7 @@ def test_shove_result_is_deterministic():
def test_shoved_trace_endpoints_still_on_pads(): def test_shoved_trace_endpoints_still_on_pads():
from freeroute.board import build_board from rpmroute.board import build_board
on, _, _ = route_dsn_board_exact(parse_dsn(SHOVE.read_text()), rip_up=False, shove=True) on, _, _ = route_dsn_board_exact(parse_dsn(SHOVE.read_text()), rip_up=False, shove=True)
board = build_board(parse_dsn(SHOVE.read_text())) board = build_board(parse_dsn(SHOVE.read_text()))
+6 -6
View File
@@ -8,12 +8,12 @@ from __future__ import annotations
import pytest import pytest
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.board.items import Pin from rpmroute.board.items import Pin
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.geometry import IntPoint from rpmroute.geometry import IntPoint
from freeroute.route.grid_router import GridRouter from rpmroute.route.grid_router import GridRouter
from freeroute.route.pipeline import route_dsn_board_exact from rpmroute.route.pipeline import route_dsn_board_exact
def _row(x0: int, pins: int = 6, skew: int = 3000) -> str: def _row(x0: int, pins: int = 6, skew: int = 3000) -> str:
+170
View File
@@ -0,0 +1,170 @@
"""Multi-pin nets: spanning-tree pairs, and connections that end on copper
their net has already routed (a T into the tree)."""
from __future__ import annotations
import pytest
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.route import exact_router
from rpmroute.route.grid_router import GridRouter, RouteResult
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
# P1 and P2 are nearest each other, so the tree pairs them first; P3 sits
# under the middle of that leg, 50 mm below it and 90 mm from either pin.
TEE = """(pcb "tee.dsn"
(parser (string_quote ") (space_in_quoted_tokens on) (host_cad "t") (host_version "1"))
(resolution um 10)
(unit um)
(structure
(layer F.Cu (type signal) (property (index 0)))
(boundary (path pcb 0 0 0 200000 0 200000 -100000 0 -100000 0 0))
(rule (width 2000) (clearance 2000))
)
(library
(padstack Rect_Pad (shape (rect F.Cu -1000 -1000 1000 1000)) (attach off))
(image PAD (pin Rect_Pad 1 0 0))
)
(placement
(component PAD
(place P1 60000 -20000 front 0)
(place P2 140000 -20000 front 0)
(place P3 100000 -70000 front 0)
)
)
(network
(net N (pins P1-1 P2-1 P3-1))
(class default (rule (width 2000) (clearance 2000)))
)
(wiring)
)
"""
def _router(tree_nets=True, text=TEE):
dsn = parse_dsn(text)
s = dsn.resolution.value
return GridRouter(
build_board(dsn),
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
orthogonal=True,
tree_nets=tree_nets,
)
def test_pairs_follow_a_spanning_tree_not_the_pin_order():
router = _router()
conns = router._build_connections()
pairs = [(c.a.component_ref, c.b.component_ref) for c in conns]
assert pairs == [("P1", "P2"), ("P1", "P3")]
chain = _router(tree_nets=False)._build_connections()
assert [(c.a.component_ref, c.b.component_ref) for c in chain] == [("P1", "P2"), ("P2", "P3")]
def test_the_third_pin_tees_into_the_first_leg():
router = _router()
result = router.route()
first, second = router._conns
assert result.unrouted == 0
# the second connection starts on the first one's copper, mid-leg
start = second.path[0]
assert start in first.copper and second.a_end is None
assert second.anchors == {first.index}
assert router._dependents[first.index] == {second.index}
assert abs(router._cell_center(start[:2]).x - 1_000_000) <= router.step
# and so its copper is the 50 mm drop, not 90 mm back to a pin
assert len(second.path) < len(router._conns[0].path)
def test_without_trees_each_connection_ends_on_a_pin():
router = _router(tree_nets=False)
router.route()
assert all(c.anchors == frozenset() for c in router._conns)
assert all(c.a_end is not None and c.b_end is not None for c in router._conns)
def test_ripping_an_anchor_takes_what_hangs_on_it():
router = _router()
router.route()
first, second = router._conns
victims = router._with_dependents([first], router._conns)
assert victims == [first, second] # anchors first, as committed
for victim in victims:
router._rip(victim)
assert not first.routed and not second.routed
assert not router._dependents.get(first.index)
assert not router._cell_owner
def test_the_snapshot_lists_anchors_before_what_hangs_on_them():
router = _router()
result = router.route()
assert result.connection_anchors == [(), (0,)]
def test_the_exact_engine_drops_a_tee_whose_anchor_it_rejects(monkeypatch):
"""A connection teed onto copper the exact check refuses would dangle."""
dsn = parse_dsn(TEE)
board = build_board(dsn)
real = exact_router.route_board
def grid_then_spoil(*args, **kwargs):
result: RouteResult = real(*args, **kwargs)
assert result.connection_anchors == [(), (0,)]
# move the first leg off the board edge so the exact check rejects it
net, wires, vias = result.connections[0]
result.connections[0] = (net, [(layer, [type(p)(p.x, p.y + 2_000_000) for p in pts])
for layer, pts in wires], vias)
return result
monkeypatch.setattr(exact_router, "route_board", grid_then_spoil)
s = dsn.resolution.value
exact = exact_router.route_board_exact(
board,
trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s),
)
assert len(exact.result.failed) == 2 # the leg and the T hanging on it
assert not exact.result.wires
@pytest.mark.parametrize("tree_nets", [True, False])
def test_occupancy_stays_honest(tree_nets):
router = _router(tree_nets)
router.route()
conns = router._conns
assert all(conns[i].routed for i in router._cell_owner.values())
for anchor, hanging in router._dependents.items():
for i in hanging:
assert conns[i].routed and conns[anchor].routed
# P1-P2 along the top, P3 far off to the lower right, P4 just under the
# middle of the P1-P2 leg.
CHAIN_TEE = TEE.replace(
""" (place P3 100000 -70000 front 0)
""",
""" (place P3 190000 -90000 front 0)
(place P4 100000 -40000 front 0)
""",
).replace("(pins P1-1 P2-1 P3-1)", "(pins P1-1 P2-1 P3-1 P4-1)")
def test_a_tee_depends_on_every_connection_back_to_its_group():
"""Joined as P1-P2, P2-P3, P3-P4, P4's connection tees onto P1-P2 copper,
which reaches P3's group only through P2-P3. Ripping P2-P3 must take the T
too, or it would be counted routed while cut off from P3."""
router = _router(text=CHAIN_TEE)
conns = router._conns = router._build_connections()
groups = {c.a.component_ref: c.a_group for c in conns}
groups.update({c.b.component_ref: c.b_group for c in conns})
for conn, (a, b) in zip(conns, (("P1", "P2"), ("P2", "P3"), ("P3", "P4")), strict=True):
conn.a_group, conn.b_group = groups[a], groups[b]
for conn in conns:
assert router._try_route(conn, conns)
first, second, third = conns
assert third.path[0] in first.copper # the T lands on the far leg
assert third.anchors == {first.index, second.index}
assert router._with_dependents([second], conns) == [second, third]
+42
View File
@@ -0,0 +1,42 @@
"""verify_result: copper no engine checked is checked on exact shapes."""
from pathlib import Path
from rpmroute.dsn import parse_dsn
from rpmroute.route.verify import verify_result
from rpmroute.ses.model import RoutedWire, RoutingResult
FIXTURE = Path(__file__).parents[1] / "dsn" / "fixtures" / "crossing_2net.dsn"
# rule: 2000 um wide traces, 2000 um clearance; NET_A runs along y = -40000
A = RoutedWire(layer="Top", width=2000, coords=[2000, -40000, 198000, -40000])
def _check(b_wire):
result = RoutingResult()
result.add_wire("NET_A", A)
result.add_wire("NET_B", b_wire)
return verify_result(parse_dsn(FIXTURE.read_text()), result)
def test_a_crossing_on_one_layer_is_a_short():
report = _check(RoutedWire(layer="Top", width=2000, coords=[100000, -15000, 100000, -65000]))
assert report.shorts == 1 and report.clearance == 0
found = report.short_examples[0]
assert {found.net, found.other} == {"NET_A", "NET_B"} and found.layer == "Top"
assert abs(found.x_mm - 100.0) < 1.5 and abs(found.y_mm + 40.0) < 1.5
def test_copper_closer_than_the_rule_is_a_clearance_violation():
# edges 1500 um apart against a 2000 um rule
report = _check(RoutedWire(layer="Top", width=2000, coords=[50000, -36500, 150000, -36500]))
assert report.shorts == 0 and report.clearance == 1
def test_exactly_the_clearance_apart_is_clean():
report = _check(RoutedWire(layer="Top", width=2000, coords=[50000, -36000, 150000, -36000]))
assert report.clean
def test_a_crossing_on_another_layer_is_clean():
report = _check(RoutedWire(layer="Bottom", width=2000, coords=[100000, -15000, 100000, -65000]))
assert report.clean
+6 -6
View File
@@ -5,8 +5,8 @@ from __future__ import annotations
import itertools import itertools
import math import math
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.route.pipeline import route_dsn_board_exact from rpmroute.route.pipeline import route_dsn_board_exact
# four GND pads 0.5 mm apart over a GND plane: each drops a via to the plane # four GND pads 0.5 mm apart over a GND plane: each drops a via to the plane
_DSN = """(pcb holes (parser) (resolution um 10) (unit um) _DSN = """(pcb holes (parser) (resolution um 10) (unit um)
@@ -57,9 +57,9 @@ def test_connections_sharing_a_plane_via_write_it_once():
def _router(dsn_text, via_drill_um=300): def _router(dsn_text, via_drill_um=300):
from freeroute.board import build_board from rpmroute.board import build_board
from freeroute.route.grid_router import GridRouter from rpmroute.route.grid_router import GridRouter
from freeroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn
dsn = parse_dsn(dsn_text) dsn = parse_dsn(dsn_text)
s = dsn.resolution.value s = dsn.resolution.value
@@ -90,7 +90,7 @@ def test_no_via_goes_near_a_through_hole_pads_hole_even_of_its_own_net():
def test_a_via_in_a_pad_keeps_hole_spacing_from_a_fixed_via(): def test_a_via_in_a_pad_keeps_hole_spacing_from_a_fixed_via():
from freeroute.geometry import IntPoint from rpmroute.geometry import IntPoint
text = _THT.replace("(network (net SIG (pins J1-1))))", text = _THT.replace("(network (net SIG (pins J1-1))))",
"(network (net SIG (pins J1-1)))\n" "(network (net SIG (pins J1-1)))\n"
+128
View File
@@ -0,0 +1,128 @@
"""Window re-route: a finer grid around a stuck connection, kept only when
it leaves fewer connections unrouted."""
from __future__ import annotations
from rpmroute.board import build_board
from rpmroute.dsn import parse_dsn
from rpmroute.geometry import IntBox
from rpmroute.route.grid_router import GridRouter
from rpmroute.route.pipeline import _rule_clearance_dsn, _rule_width_dsn, route_dsn_board_exact
def _slot(gap: int = 640, far: bool = False) -> str:
"""A wall across the board with a slot in it. A trace fits the slot
only along a narrow band of heights that the board's 1x grid has no row
in and a 4x grid does. ``far`` adds a second net nowhere near the wall."""
yc = -5000
lo, hi = yc - gap // 2, yc + gap // 2
extra_place = "(place Q1 2000 -1000 front 0) (place Q2 6000 -1000 front 0)" if far else ""
extra_net = "(net M (pins Q1-1 Q2-1))" if far else ""
return f"""(pcb "slot.dsn"
(parser (string_quote ") (space_in_quoted_tokens on) (host_cad "t") (host_version "1"))
(resolution um 10)
(unit um)
(structure
(layer F.Cu (type signal) (property (index 0)))
(boundary (path pcb 0 0 0 20000 0 20000 -10000 0 -10000 0 0))
(keepout "" (rect F.Cu 9000 -10000 11000 {lo}))
(keepout "" (rect F.Cu 9000 {hi} 11000 0))
(rule (width 200) (clearance 200))
)
(library
(padstack Rect_Pad (shape (rect F.Cu -100 -100 100 100)) (attach off))
(image PAD (pin Rect_Pad 1 0 0))
)
(placement
(component PAD
(place P1 3000 {yc} front 0)
(place P2 17000 {yc} front 0)
{extra_place}
)
)
(network
(net N (pins P1-1 P2-1))
{extra_net}
(class default (rule (width 200) (clearance 200)))
)
(wiring)
)
"""
def _route(text: str, rounds: int, **window):
exact, _scale, _layers = route_dsn_board_exact(
parse_dsn(text), resolution=1, window_reroute=rounds, window_resolution=4, **window,
)
return exact.result
def test_the_board_grid_misses_the_slot_and_a_finer_window_finds_it():
plain = _route(_slot(), 0)
assert len(plain.failed) == 1
windowed = _route(_slot(), 1)
assert windowed.failed == []
assert windowed.wires # and the copper it found is in the result
def test_a_window_that_cannot_help_leaves_the_board_as_it_was():
plain = _route(_slot(gap=500, far=True), 0) # too narrow for any grid
windowed = _route(_slot(gap=500, far=True), 2)
assert len(windowed.failed) == len(plain.failed) == 1
assert windowed.wires == plain.wires
assert windowed.vias == plain.vias
def test_copper_outside_the_window_is_kept_as_it_was():
plain = _route(_slot(far=True), 0)
windowed = _route(_slot(far=True), 1)
assert windowed.failed == []
far_net = 2 # M, the second net in the DSN
assert windowed.wires[far_net] == plain.wires[far_net]
def test_a_router_limited_to_some_nets_and_a_box_builds_only_those():
dsn = parse_dsn(_slot(far=True))
s = dsn.resolution.value
board = build_board(dsn)
whole = GridRouter(board, trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), orthogonal=True)
part = GridRouter(board, trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), orthogonal=True,
only_nets=frozenset({2}), bounds=IntBox(0, -20000, 80000, 0))
assert {c.net_no for c in whole._build_connections()} == {1, 2}
assert {c.net_no for c in part._build_connections()} == {2}
assert part.cols * part.rows < whole.cols * whole.rows
def test_a_spent_budget_starts_no_window():
assert len(_route(_slot(), 1, window_budget=0.0).failed) == 1
assert _route(_slot(), 1, window_budget=1000.0).failed == []
def test_window_board_keeps_far_items_of_the_rerouted_nets_only():
from rpmroute.route.window import _item_box, _window_board
board = build_board(parse_dsn(_slot(far=True)))
items = [(item, _item_box(item)) for item in board.get_items()]
view = IntBox(80000, -60000, 120000, -40000) # around the slot, far from Q1/Q2
sub = _window_board(board, items, view, {1}, {}, set(), {}, 100, 300, 300, [0], "via")
refs = {p.component_ref for p in sub.get_pins()}
assert {"P1", "P2"} <= refs # net N's pins, though outside the view
assert not refs & {"Q1", "Q2"} # net M's, far away, left out
def test_a_connection_ending_outside_the_window_gets_no_copper():
"""Its far end has no grid cells; a stub out to it would cross items the
window board never saw."""
from rpmroute.route.exact_router import route_board_exact
dsn = parse_dsn(_slot(far=True))
s = dsn.resolution.value
window = IntBox(70000, -70000, 130000, -30000) # the slot only; net M's pins are far off
result = route_board_exact(
build_board(dsn), trace_width=round(_rule_width_dsn(dsn) * s),
clearance=round(_rule_clearance_dsn(dsn) * s), only_nets=frozenset({2}), bounds=window,
).result
assert [f[0] for f in result.failed] == [2]
assert not result.wires.get(2) and not result.vias.get(2)
+1 -1
View File
@@ -2,7 +2,7 @@
from __future__ import annotations from __future__ import annotations
from freeroute.ses.indent import Identifier, IndentWriter from rpmroute.ses.indent import Identifier, IndentWriter
def test_nested_scopes_indent_by_two_spaces(): def test_nested_scopes_indent_by_two_spaces():
+7 -7
View File
@@ -1,7 +1,7 @@
"""End-to-end tests for the SES writer. """End-to-end tests for the SES writer.
Where possible these re-parse the emitted SES with the project's own tokenizer / Where possible these re-parse the emitted SES with the project's own tokenizer /
S-expression parser (:mod:`freeroute.dsn.sexp`) and assert structural S-expression parser (:mod:`rpmroute.dsn.sexp`) and assert structural
invariants, mirroring what FreeRouting's ``SesReader`` and ``kicad-cli pcb invariants, mirroring what FreeRouting's ``SesReader`` and ``kicad-cli pcb
import specctra-ses`` walk: ``session > routes > network_out > net > import specctra-ses`` walk: ``session > routes > network_out > net >
wire(path)/via``. wire(path)/via``.
@@ -13,9 +13,9 @@ from pathlib import Path
import pytest import pytest
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.dsn.sexp import SExp, parse from rpmroute.dsn.sexp import SExp, parse
from freeroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses from rpmroute.ses import RoutedVia, RoutedWire, RoutingResult, write_ses
FIXTURES = Path(__file__).parent.parent / "dsn" / "fixtures" FIXTURES = Path(__file__).parent.parent / "dsn" / "fixtures"
@@ -142,7 +142,7 @@ def test_round_trip_from_empty_board_fixture():
# --- SES coordinate units --------------------------------------------------- # --- SES coordinate units ---------------------------------------------------
# FreeRouting's SesWriter writes coordinates in resolution units, and KiCad's # FreeRouting's SesWriter writes coordinates in resolution units, and KiCad's
# importer and mckicad's ses_apply read them that way. On 2026-09-26 freeroute # importer and mckicad's ses_apply read them that way. On 2026-09-26 rpmroute
# was found writing DSN units instead, so every routed board came back 10x small. # was found writing DSN units instead, so every routed board came back 10x small.
@@ -155,8 +155,8 @@ def test_round_trip_from_empty_board_fixture():
], ],
) )
def test_ses_scale(resolution, unit, expected): def test_ses_scale(resolution, unit, expected):
from freeroute.dsn import parse_dsn from rpmroute.dsn import parse_dsn
from freeroute.ses.writer import ses_scale from rpmroute.ses.writer import ses_scale
dsn = parse_dsn(f"(pcb t (parser) {resolution} {unit} (structure) (placement) (library) (network))") dsn = parse_dsn(f"(pcb t (parser) {resolution} {unit} (structure) (placement) (library) (network))")
assert ses_scale(dsn) == pytest.approx(expected) assert ses_scale(dsn) == pytest.approx(expected)
+38 -7
View File
@@ -1,4 +1,4 @@
"""Tests for the freeroute CLI (Specctra DSN in, SES out). """Tests for the rpmroute CLI (Specctra DSN in, SES out).
Covers the engine selection contract: every engine must route a fixture from the Covers the engine selection contract: every engine must route a fixture from the
command line, and every option the selected engine does not implement must fail command line, and every option the selected engine does not implement must fail
@@ -11,7 +11,7 @@ from pathlib import Path
import pytest import pytest
from freeroute.cli import ENGINE_OPTIONS, main from rpmroute.cli import ENGINE_OPTIONS, main
FIXTURES = Path(__file__).parent / "dsn" / "fixtures" FIXTURES = Path(__file__).parent / "dsn" / "fixtures"
FIXTURE = FIXTURES / "simple_2net.dsn" FIXTURE = FIXTURES / "simple_2net.dsn"
@@ -71,13 +71,39 @@ def test_cli_every_engine_routes_a_fixture(engine, tmp_path):
assert "(wire" in text assert "(wire" in text
def test_cli_default_engine_is_grid(tmp_path): def test_cli_default_engine_is_exact(tmp_path):
"""The default must stay grid — the drop-in JAR replacement behaviour.""" """The default is the engine that checks its copper: grid output can short
and say nothing (a user routing with no flags shipped 15 crossings)."""
default = tmp_path / "default.ses" default = tmp_path / "default.ses"
grid = tmp_path / "grid.ses" exact = tmp_path / "exact.ses"
assert main([str(FIXTURE), "-do", str(default)]) == 0 assert main([str(FIXTURE), "-do", str(default)]) == 0
assert main([str(FIXTURE), "--engine", "grid", "-do", str(grid)]) == 0 assert main([str(FIXTURE), "--engine", "exact", "-do", str(exact)]) == 0
assert default.read_text() == grid.read_text() assert default.read_text() == exact.read_text()
@pytest.mark.parametrize("engine", ["grid", "room"])
def test_unchecked_engines_are_checked_after_routing(tmp_path, capsys, engine):
assert main([str(FIXTURE), "--engine", engine, "-do", str(tmp_path / "out.ses")]) == 0
assert f"{engine} output checked on exact shapes: 0 short(s), 0 clearance" in capsys.readouterr().err
def test_strict_fails_a_run_whose_copper_is_not_clean(tmp_path, monkeypatch, capsys):
from rpmroute import cli
from rpmroute.route.verify import VerifyReport, Violation
bad = VerifyReport(shorts=1, short_examples=[Violation("A", "B", "F.Cu", 1.0, 2.0)])
monkeypatch.setattr(cli, "verify_result", lambda dsn, result: bad)
out = tmp_path / "out.ses"
assert main([str(FIXTURE), "--engine", "grid", "-do", str(out)]) == 0
assert main([str(FIXTURE), "--engine", "grid", "--strict", "-do", str(out)]) == 3
assert out.exists() # the session is still written
err = capsys.readouterr().err
assert "short: A x B on F.Cu at (1.00, 2.00) mm" in err and "not DRC-clean" in err
def test_the_exact_engine_does_not_warn(tmp_path, capsys):
assert main([str(FIXTURE), "-do", str(tmp_path / "out.ses")]) == 0
assert "WARNING" not in capsys.readouterr().err
def test_cli_room_pack_routes(tmp_path): def test_cli_room_pack_routes(tmp_path):
@@ -158,7 +184,12 @@ def test_cli_supported_combinations_are_accepted(tmp_path):
"orders": ["--orders", "2"], "orders": ["--orders", "2"],
"promote": ["--promote-failures", "2"], "promote": ["--promote-failures", "2"],
"access": ["--access-cost", "5"], "access": ["--access-cost", "5"],
"negotiate": ["--negotiate", "2"],
"rollback": ["--no-rollback"], "rollback": ["--no-rollback"],
"tree": ["--no-tree"],
"window": ["--window-reroute", "1"],
"vias": ["--reduce-vias"],
"via_cost": ["--via-cost", "40"],
} }
for engine, options in ENGINE_OPTIONS.items(): for engine, options in ENGINE_OPTIONS.items():
for option in options: for option in options:
Generated
+21 -21
View File
@@ -126,27 +126,6 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/8a/0e/97c33bf5009bdbac74fd2beace167cab3f978feb69cc36f1ef79360d6c4e/exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598", size = 16740, upload-time = "2025-11-21T23:01:53.443Z" }, { url = "https://files.pythonhosted.org/packages/8a/0e/97c33bf5009bdbac74fd2beace167cab3f978feb69cc36f1ef79360d6c4e/exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598", size = 16740, upload-time = "2025-11-21T23:01:53.443Z" },
] ]
[[package]]
name = "freeroute"
version = "2026.7.14"
source = { editable = "." }
[package.dev-dependencies]
dev = [
{ name = "pytest" },
{ name = "pytest-cov" },
{ name = "ruff" },
]
[package.metadata]
[package.metadata.requires-dev]
dev = [
{ name = "pytest", specifier = ">=7.0.0" },
{ name = "pytest-cov", specifier = ">=4.0.0" },
{ name = "ruff", specifier = ">=0.1.0" },
]
[[package]] [[package]]
name = "iniconfig" name = "iniconfig"
version = "2.3.0" version = "2.3.0"
@@ -215,6 +194,27 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/9d/7a/d968e294073affff457b041c2be9868a40c1c71f4a35fcc1e45e5493067b/pytest_cov-7.1.0-py3-none-any.whl", hash = "sha256:a0461110b7865f9a271aa1b51e516c9a95de9d696734a2f71e3e78f46e1d4678", size = 22876, upload-time = "2026-03-21T20:11:14.438Z" }, { url = "https://files.pythonhosted.org/packages/9d/7a/d968e294073affff457b041c2be9868a40c1c71f4a35fcc1e45e5493067b/pytest_cov-7.1.0-py3-none-any.whl", hash = "sha256:a0461110b7865f9a271aa1b51e516c9a95de9d696734a2f71e3e78f46e1d4678", size = 22876, upload-time = "2026-03-21T20:11:14.438Z" },
] ]
[[package]]
name = "rpmroute"
version = "2026.10.7"
source = { editable = "." }
[package.dev-dependencies]
dev = [
{ name = "pytest" },
{ name = "pytest-cov" },
{ name = "ruff" },
]
[package.metadata]
[package.metadata.requires-dev]
dev = [
{ name = "pytest", specifier = ">=7.0.0" },
{ name = "pytest-cov", specifier = ">=4.0.0" },
{ name = "ruff", specifier = ">=0.1.0" },
]
[[package]] [[package]]
name = "ruff" name = "ruff"
version = "0.15.21" version = "0.15.21"