Fix Magic setup for SKY130 PDK validation

Author: ROMERUU-dev

README.md

@@ -67,11 +67,11 @@ Create `.venv` as your normal user. Do not create or repair the repository virtu
 
 If the GUI already opens on your machine, go to `⬢ Entorno / Setup` and follow the wizard.
 
-The Ubuntu bootstrap currently installs Ubuntu system packages only:
+The Ubuntu bootstrap installs Ubuntu system packages plus the official Magic `8.3.634` source release:
 
 - `xschem`
 - `ngspice`
-- `magic`
+- `magic` from apt as a baseline, then `/usr/local/bin/magic` built from the official `magic-8.3.634.tgz` release
 - `netgen-lvs` (accepted by the app as Netgen)
 - `klayout`
 - `python3`, `python3-pip`, `python3-venv`
@@ -87,6 +87,15 @@ python3 -m venv .venv
 .venv/bin/python -m pip install -r requirements.txt
 ```
 
+Some current SKY130 PDK techfiles require a newer Magic revision than the one shipped by older Ubuntu apt repositories. The Setup Assistant handles this during a clean tool install. If you are repairing an existing machine manually, install the official Magic `8.3.634` source release:
+
+```bash
+bash scripts/install_magic_8_3_634_ubuntu.sh
+/usr/local/bin/magic -dnull -noconsole -version
+```
+
+Then set the Magic executable in Preferences to `/usr/local/bin/magic` if `which magic` still resolves to `/usr/bin/magic`.
+
 ## Ubuntu Environment Notes
 
 The app works best when these are available:
@@ -104,8 +113,9 @@ The Setup Assistant can detect common installations and apply discovered paths a
 
 Important:
 
-- the tool bootstrap is implemented for Ubuntu/Debian-style systems using `apt`
+- the tool bootstrap is implemented for Ubuntu/Debian-style systems using `apt` plus the official Magic source release
 - installing apt packages does not install the SKY130 PDK automatically
+- older Ubuntu apt repositories may ship Magic revisions too old for current SKY130 techfiles; use `scripts/install_magic_8_3_634_ubuntu.sh` when the validator reports a Magic/PDK incompatibility
 - the validator looks for `sky130A` in `PDK_ROOT`, `/usr/local/share/pdk`, `/usr/share/pdk`, `~/pdk`, `~/.volare`, and `~/eda/pdk`
 - the app checks `sky130A/libs.tech/magic`, `netgen`, `klayout`, `ngspice`, and `xschem` separately, so an incomplete PDK is reported as incomplete rather than OK
 - a repository under `/opt` may be readable but not writable for the current user; in that case `.venv` creation is intentionally reported as a permissions problem

app/core/env_validator.py

@@ -5,6 +5,7 @@
 import ctypes.util
 import os
 import pwd
+import re
 import shutil
 import subprocess
 from collections import OrderedDict
@@ -137,7 +138,7 @@ def diagnose(self, settings: AppSettings, lang: str = "en") -> EnvironmentDiagno
             (name, self._detect_tool(name, getattr(settings.tool_paths, name, ""), lang))
             for name in ("xschem", "ngspice", "magic", "netgen", "klayout")
         )
-        pdk = self._detect_pdk(settings, lang)
+        pdk = self._detect_pdk(settings, lang, magic_version=tools["magic"].version)
         python_env = self._detect_python_environment(lang)
         gui_dependencies = self._detect_gui_dependencies(lang)
         recommendations = self._build_recommendations(tools, pdk, python_env, gui_dependencies, lang)
@@ -255,7 +256,7 @@ def _detect_tool(self, logical_name: str, configured_value: str, lang: str) -> T
             ),
         )
 
-    def _detect_pdk(self, settings: AppSettings, lang: str) -> PdkDiagnosis:
+    def _detect_pdk(self, settings: AppSettings, lang: str, magic_version: str = "") -> PdkDiagnosis:
         sky130a = self._find_sky130a(settings)
         if sky130a is None:
             return PdkDiagnosis(
@@ -273,20 +274,29 @@ def _detect_pdk(self, settings: AppSettings, lang: str) -> PdkDiagnosis:
             for relative in REQUIRED_PDK_SUBDIRS.values()
             if not sky130a.joinpath(relative).exists()
         ]
-        status = "present" if not missing_subdirs else "incomplete"
-        message = (
-            pick(
-                lang,
-                f"PDK `sky130A` detectado en: {sky130a}",
-                f"`sky130A` PDK detected at: {sky130a}",
-            )
-            if status == "present"
-            else pick(
+        magic_requirement = self._detect_magic_tech_requirement(sky130a, magic_version)
+        if missing_subdirs:
+            status = "incomplete"
+            message = pick(
                 lang,
                 f"El PDK `sky130A` existe en {sky130a}, pero está incompleto. Faltan: {', '.join(missing_subdirs)}.",
                 f"The `sky130A` PDK exists at {sky130a}, but it is incomplete. Missing: {', '.join(missing_subdirs)}.",
             )
-        )
+        elif magic_requirement:
+            required, detected = magic_requirement
+            status = "incompatible"
+            message = pick(
+                lang,
+                f"El PDK `sky130A` requiere Magic {required} o superior, pero se detectó Magic {detected}. Actualiza Magic o usa un PDK compatible.",
+                f"The `sky130A` PDK requires Magic {required} or newer, but Magic {detected} was detected. Upgrade Magic or use a compatible PDK.",
+            )
+        else:
+            status = "present"
+            message = pick(
+                lang,
+                f"PDK `sky130A` detectado en: {sky130a}",
+                f"`sky130A` PDK detected at: {sky130a}",
+            )
         return PdkDiagnosis(
             found=True,
             status=status,
@@ -470,6 +480,14 @@ def _build_recommendations(
                     "Complete `sky130A/libs.tech/*` or fix `PDK_ROOT` so the app uses a complete PDK.",
                 )
             )
+        elif pdk.status == "incompatible":
+            recommendations.append(
+                pick(
+                    lang,
+                    "Actualiza Magic para que cumpla la versión mínima declarada por `sky130A.tech`, o apunta la app a un PDK compatible con tu Magic instalado.",
+                    "Upgrade Magic so it meets the minimum version declared by `sky130A.tech`, or point the app to a PDK compatible with your installed Magic.",
+                )
+            )
         if python_env.problems:
             recommendations.append(
                 pick(
@@ -589,6 +607,42 @@ def _check_python_requirements(python_bin: Path) -> bool:
             return False
         return result.returncode == 0 and result.stdout.strip() == "OK"
 
+    @classmethod
+    def _detect_magic_tech_requirement(cls, sky130a: Path, magic_version: str) -> tuple[str, str] | None:
+        techfile = sky130a / "libs.tech" / "magic" / "sky130A.tech"
+        if not techfile.is_file() or not magic_version:
+            return None
+        required_text = cls._read_magic_tech_required_version(techfile)
+        required = cls._parse_version_tuple(required_text)
+        detected = cls._parse_version_tuple(magic_version)
+        if required is None or detected is None:
+            return None
+        if detected < required:
+            return (required_text, ".".join(str(part) for part in detected))
+        return None
+
+    @staticmethod
+    def _read_magic_tech_required_version(techfile: Path) -> str:
+        try:
+            text = techfile.read_text(encoding="utf-8", errors="replace")
+        except OSError:
+            return ""
+        for line in text.splitlines()[:80]:
+            match = re.search(r"\bversion\s+([0-9]+(?:\.[0-9]+){1,3})\b", line, flags=re.IGNORECASE)
+            if match:
+                return match.group(1)
+        return ""
+
+    @staticmethod
+    def _parse_version_tuple(text: str) -> tuple[int, ...] | None:
+        revision_match = re.search(r"\bMagic\s+([0-9]+)\.([0-9]+)\s+revision\s+([0-9]+)\b", text, flags=re.IGNORECASE)
+        if revision_match:
+            return tuple(int(part) for part in revision_match.groups())
+        match = re.search(r"\b([0-9]+(?:\.[0-9]+){1,3})\b", text)
+        if not match:
+            return None
+        return tuple(int(part) for part in match.group(1).split("."))
+
     @staticmethod
     def _query_version(logical_name: str, executable: str) -> str:
         for args in TOOL_VERSION_ARGS.get(logical_name, (("--version",),)):
@@ -663,6 +717,7 @@ def _tool_status_label(status: str, lang: str) -> str:
     def _pdk_status_label(status: str, lang: str) -> str:
         mapping = {
             "present": pick(lang, "PRESENTE", "PRESENT"),
+            "incompatible": pick(lang, "INCOMPATIBLE", "INCOMPATIBLE"),
             "incomplete": pick(lang, "INCOMPLETO", "INCOMPLETE"),
             "missing": pick(lang, "AUSENTE", "ABSENT"),
         }

app/ui/setup_tab.py

@@ -314,8 +314,8 @@ def _build_install_page(self) -> QWidget:
             self._page_hint(
                 pick(
                     self.lang,
-                    "Este paso instala paquetes del sistema para Ubuntu: herramientas EDA base y librerías Qt/X11. No crea `.venv` ni toca el entorno Python del usuario.",
-                    "This step installs Ubuntu system packages: base EDA tools and Qt/X11 runtime libraries. It does not create `.venv` or touch the user-owned Python environment.",
+                    "Este paso instala paquetes del sistema para Ubuntu y compila Magic 8.3.634 desde la fuente oficial para SKY130. No crea `.venv` ni toca el entorno Python del usuario.",
+                    "This step installs Ubuntu system packages and builds Magic 8.3.634 from the official source release for SKY130. It does not create `.venv` or touch the user-owned Python environment.",
                 )
             )
         )
@@ -788,8 +788,8 @@ def install_environment(self) -> None:
         self.log.append(
             pick(
                 self.lang,
-                "Lanzando bootstrap de Ubuntu con privilegios. Este paso solo instala paquetes del sistema; `.venv` debe prepararse después como usuario normal.\n",
-                "Launching Ubuntu bootstrap with privileges. This step only installs system packages; `.venv` must be prepared afterwards as the normal user.\n",
+                "Lanzando bootstrap de Ubuntu con privilegios. Este paso instala paquetes del sistema y Magic 8.3.634; `.venv` debe prepararse después como usuario normal.\n",
+                "Launching Ubuntu bootstrap with privileges. This step installs system packages and Magic 8.3.634; `.venv` must be prepared afterwards as the normal user.\n",
             )
         )
         self.send_status.emit(pick(self.lang, "Instalación en progreso", "Installation in progress"))

scripts/install_magic_8_3_634_ubuntu.sh

@@ -0,0 +1,90 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+MAGIC_VERSION="${MAGIC_VERSION:-8.3.634}"
+MAGIC_TARBALL_URL="${MAGIC_TARBALL_URL:-http://www.opencircuitdesign.com/magic/archive/magic-${MAGIC_VERSION}.tgz}"
+PREFIX="${PREFIX:-/usr/local}"
+BUILD_ROOT="${BUILD_ROOT:-$HOME/src/magic-build}"
+
+SUDO=""
+if [ "$(id -u)" -ne 0 ]; then
+  SUDO="sudo"
+fi
+
+download() {
+  local url="$1"
+  local output="$2"
+
+  if command -v curl >/dev/null 2>&1; then
+    curl -L --fail --output "$output" "$url"
+    return
+  fi
+  if command -v wget >/dev/null 2>&1; then
+    wget -O "$output" "$url"
+    return
+  fi
+
+  echo "curl or wget is required to download Magic." >&2
+  exit 1
+}
+
+echo "== Magic ${MAGIC_VERSION} source install =="
+echo "Source: $MAGIC_TARBALL_URL"
+echo "Prefix: $PREFIX"
+echo "Build root: $BUILD_ROOT"
+echo
+
+if ! command -v apt-get >/dev/null 2>&1; then
+  echo "This installer currently supports Ubuntu/Debian systems with apt-get." >&2
+  exit 1
+fi
+
+echo "Installing Magic build dependencies..."
+$SUDO apt-get update
+$SUDO apt-get install -y \
+  build-essential \
+  m4 \
+  tcsh \
+  tcl-dev \
+  tk-dev \
+  libcairo2-dev \
+  libx11-dev \
+  libxft-dev \
+  libxrender-dev \
+  libglu1-mesa-dev \
+  curl \
+  ca-certificates
+
+mkdir -p "$BUILD_ROOT"
+cd "$BUILD_ROOT"
+
+tarball="magic-${MAGIC_VERSION}.tgz"
+srcdir="magic-${MAGIC_VERSION}"
+
+if [ ! -f "$tarball" ]; then
+  echo "Downloading $tarball..."
+  download "$MAGIC_TARBALL_URL" "$tarball"
+else
+  echo "Using existing $BUILD_ROOT/$tarball"
+fi
+
+rm -rf "$srcdir"
+tar -xzf "$tarball"
+cd "$srcdir"
+
+echo "Configuring Magic..."
+./configure --prefix="$PREFIX"
+
+echo "Building Magic..."
+make
+
+echo "Installing Magic into $PREFIX..."
+$SUDO make install
+
+echo
+echo "Installed Magic version:"
+"$PREFIX/bin/magic" -dnull -noconsole -version
+echo
+echo "If your shell still finds an older Magic first, put $PREFIX/bin before /usr/bin in PATH"
+echo "or set the Magic path in the app Preferences to:"
+echo "  $PREFIX/bin/magic"

scripts/install_vlsi_env_ubuntu.sh

@@ -60,6 +60,17 @@ apt-get install -y "${APT_PACKAGES[@]}"
 echo
 echo "Package installation finished."
 echo
+echo "Installing official Magic 8.3.634 source release for current SKY130 techfiles..."
+MAGIC_INSTALLER="$REPO_ROOT/scripts/install_magic_8_3_634_ubuntu.sh"
+if [ ! -f "$MAGIC_INSTALLER" ]; then
+  echo "Magic source installer not found at $MAGIC_INSTALLER."
+  exit 1
+fi
+/bin/bash "$MAGIC_INSTALLER"
+
+echo
+echo "Magic source installation finished."
+echo
 echo "System bootstrap completed."
 echo "This script intentionally does NOT create or modify $REPO_ROOT/.venv."
 echo "Create the Python environment later as the normal user, for example:"

tests/test_env_validator.py

@@ -64,6 +64,35 @@ def test_pdk_incomplete_is_not_reported_as_ready(self) -> None:
         self.assertEqual(pdk.status, "incomplete")
         self.assertIn("libs.tech/netgen", pdk.missing_subdirs)
 
+    def test_pdk_reports_magic_techfile_version_mismatch(self) -> None:
+        with tempfile.TemporaryDirectory() as tmpdir:
+            sky130a = Path(tmpdir) / "pdk" / "sky130A"
+            for relative in (
+                "libs.tech/magic",
+                "libs.tech/netgen",
+                "libs.tech/klayout",
+                "libs.tech/ngspice",
+                "libs.tech/xschem",
+            ):
+                (sky130a / relative).mkdir(parents=True)
+            (sky130a / "libs.tech" / "magic" / "sky130A.tech").write_text(
+                "tech\nversion 8.3.411\n",
+                encoding="utf-8",
+            )
+            self.settings.pdk_paths.pdk_root = str(Path(tmpdir) / "pdk")
+
+            with mock.patch.dict(os.environ, {}, clear=True):
+                pdk = self.validator._detect_pdk(
+                    self.settings,
+                    lang="en",
+                    magic_version="Magic 8.3 revision 105 - Compiled on Mon, 06 Dec 2021 22:32:27 +0200.",
+                )
+
+        self.assertTrue(pdk.found)
+        self.assertEqual(pdk.status, "incompatible")
+        self.assertIn("requires Magic 8.3.411", pdk.message)
+        self.assertIn("Magic 8.3.105 was detected", pdk.message)
+
     def test_root_owned_venv_problem_is_reported(self) -> None:
         with tempfile.TemporaryDirectory() as tmpdir:
             repo_root = Path(tmpdir)