mooncake-track
/
dynamo
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
dynamo/deploy/sanity_check.py

3447 lines
132 KiB
Python
Executable File
Raw Blame History

#!/usr/bin/env python3
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
"""
Dynamo System Information Checker
Diagnostic tool that displays system configuration and Dynamo project status
in a hierarchical tree format. This script checks for:
Default checks:
- System resources (OS, CPU, memory, GPU)
- Container/host context (execution context, /dev/shm sizing, selected env)
- Development tools (Cargo/Rust, Maturin, Python)
- LLM frameworks (vllm, sglang, tensorrt_llm)
- Dynamo runtime and framework components
- Installation status and component availability
Additional checks with --thorough-check:
- File system permissions (file-level analysis)
- Directory sizes and disk space
- Ulimits (resource limits)
- CUDA/NVIDIA information (nvidia-smi, nvcc, env vars, dpkg, pip packages)
- DYN_* environment variables
- HuggingFace model cache details
IMPORTANT: This script is STANDALONE and uses only Python stdlib (no Dynamo components).
Why: Must work before Dynamo is built/installed (CI, fresh containers, build failures).
This tool is for pre-deployment validation; dynamo.common.config_dump is for runtime.
Hard-coded paths: Uses defaults (e.g., ~/.cache/huggingface/hub) for predictable
behavior even when environment variables are misconfigured. See class docs for details.
The output uses status indicators:
- ✅ Component found and working
- ❌ Component missing or error
- ⚠️ Warning condition
- ❓ Component not found (for optional items)
`--json-output` prints a minified JSON tree (terse subset) for copy/paste into issues.
Exit codes:
- 0: All critical components are present
- 1: One or more errors detected (❌ status)
Example output (default mode):
System info (hostname=jensen-linux, IP=10.111.122.133)
├─ OS Ubuntu 24.04.1 LTS (Noble Numbat) (Linux 6.11.0-28-generic x86_64), Memory=26.7/125.5 GiB, Cores=32
│ ├─ Execution context: container
│ ├─ DYNAMO_COMMIT_SHA: <sha or "not set">
│ └─ Shared memory (/dev/shm): <used/total/avail>
├─ User info: user=ubuntu, uid=1000, gid=1000
├─ ✅ NVIDIA GPU: NVIDIA RTX 6000 Ada Generation, Power=23.25/300.00 W, Memory=289/49140 MiB
│ ├─ Driver version: 570.133.07
│ └─ nvidia-smi CUDA: 12.8 (driver max supported)
├─ 🤖Framework
│ ├─ ✅ vLLM: 0.10.1.1, module=/opt/vllm/vllm/__init__.py, exec=/opt/dynamo/venv/bin/vllm
│ └─ ✅ Sglang: 0.3.0, module=/opt/sglang/sglang/__init__.py
├─ File System
│ ├─ ✅ Dynamo workspace ($HOME/dynamo) writable
│ ├─ ✅ Dynamo .git directory writable
│ ├─ ✅ Rustup home ($HOME/.rustup) writable
│ ├─ ✅ Cargo home ($HOME/.cargo) writable
│ ├─ ✅ Cargo target ($HOME/dynamo/.build/target) writable
│ └─ ✅ Python site-packages ($HOME/dynamo/venv/lib/python3.12/site-packages) writable
├─ ✅ Hugging Face Cache: 3 models in ~/.cache/huggingface/hub (host mount)
├─ ✅ Cargo: $HOME/.cargo/bin/cargo, cargo 1.89.0 (c24e10642 2025-06-23)
│ ├─ Cargo home directory: CARGO_HOME=$HOME/.cargo
│ └─ Cargo target directory: CARGO_TARGET_DIR=$HOME/dynamo/.build/target
│ ├─ Debug: $HOME/dynamo/.build/target/debug, modified=2025-08-30 16:26:49 PDT
│ ├─ Release: $HOME/dynamo/.build/target/release, modified=2025-08-30 18:21:12 PDT
│ └─ Binary: $HOME/dynamo/.build/target/debug/libdynamo_llm_capi.so, modified=2025-08-30 16:25:37 PDT
├─ ✅ Maturin: /opt/dynamo/venv/bin/maturin, maturin 1.9.3
├─ ✅ Python: 3.12.3, /opt/dynamo/venv/bin/python
│ ├─ ✅ PyTorch: 2.7.1+cu128, ✅torch.cuda.is_available
│ ├─ ✅ NIXL: 0.9.0
│ └─ PYTHONPATH: not set
└─ Dynamo: $HOME/dynamo
├─ Git HEAD: a03d29066, branch=main, Date: 2025-08-30 16:22:29 PDT
├─ ✅ Runtime components: ai-dynamo-runtime 0.4.1
│ ├─ ✅ dynamo._core $HOME/dynamo/lib/bindings/python/src/dynamo/_core.cpython-312-x86_64-linux-gnu.so
│ ├─ ✅ dynamo.logits_processing $HOME/dynamo/lib/bindings/python/src/dynamo/logits_processing/__init__.py
│ ├─ ✅ dynamo.nixl_connect $HOME/dynamo/lib/bindings/python/src/dynamo/nixl_connect/__init__.py
│ ├─ ✅ dynamo.llm $HOME/dynamo/lib/bindings/python/src/dynamo/llm/__init__.py
│ └─ ✅ dynamo.runtime $HOME/dynamo/lib/bindings/python/src/dynamo/runtime/__init__.py
└─ ✅ Framework components: ai-dynamo 0.5.0
├─ ✅ dynamo.frontend $HOME/dynamo/components/src/dynamo/frontend/__init__.py
├─ ✅ dynamo.llama_cpp $HOME/dynamo/components/src/dynamo/llama_cpp/__init__.py
├─ ✅ dynamo.sglang $HOME/dynamo/components/src/dynamo/sglang/__init__.py
├─ ✅ dynamo.trtllm $HOME/dynamo/components/src/dynamo/trtllm/__init__.py
└─ ✅ dynamo.vllm $HOME/dynamo/components/src/dynamo/vllm/__init__.py
Additional output with --thorough-check:
├─ File System
│ ├─ ✅ Dynamo workspace ($HOME/dynamo) writable, size=1.2 GiB, disk=500 GiB free
│ │ ├─ Total files: 1234, Total dirs: 567
│ │ └─ Writable files: 1234, Writable dirs: 567
│ └─ ... (similar detail for other directories)
├─ ✅ Hugging Face Cache: 3 models in ~/.cache/huggingface/hub (host mount)
│ ├─ Model 1: meta-llama/Llama-2-7b-hf, downloaded=2025-01-05, size=13.5 GiB
│ ├─ Model 2: meta-llama/Llama-2-13b-hf, downloaded=2025-01-06, size=26.0 GiB
│ └─ Model 3: mistralai/Mistral-7B-v0.1, downloaded=2025-01-07, size=14.5 GiB
├─ ✅ NVIDIA GPU: NVIDIA RTX 6000 Ada Generation, Power=23.25/300.00 W, Memory=289/49140 MiB
│ ├─ Driver version: 570.133.07
│ ├─ nvidia-smi CUDA: 12.8 (driver max supported)
│ ├─ nvcc CUDA: 12.9 (installed toolkit)
│ └─ CUDA/NVIDIA Information (with --thorough)
│ ├─ nvidia-smi: NVIDIA-SMI 570.133.07, Driver 570.133.07, CUDA 12.8
│ ├─ nvcc: Cuda compilation tools, release 12.9, V12.9.41
│ ├─ CUDA_VERSION: CUDA_VERSION=12.9.0
│ ├─ NV_CUDA_CUDART_VERSION: NV_CUDA_CUDART_VERSION=12.9.37-1
│ ├─ NV_CUDA_LIB_VERSION: NV_CUDA_LIB_VERSION=12.9.0-1
│ ├─ NV_LIBNCCL_PACKAGE: NV_LIBNCCL_PACKAGE=libnccl2=2.26.5-1+cuda12.9
│ ├─ NVIDIA_REQUIRE_CUDA: NVIDIA_REQUIRE_CUDA=cuda>=12.9 brand=unknown,driver>=535...
│ ├─ dpkg:cuda-*
│ │ ├─ ii cuda-command-line-tools-12-9 12.9.1-1
│ │ ├─ ii cuda-cudart-12-9 12.9.37-1
│ │ └─ ... (more packages)
│ ├─ dpkg:libcublas/libnccl
│ │ └─ hi libcublas-12-9 12.9.0.13-1
│ └─ pip:cuda-related
│ ├─ nvidia-cublas-cu12==12.9.1.4
│ ├─ nvidia-cudnn-cu12==9.10.2.21
│ ├─ torch==2.9.0+cu129
│ └─ ... (more packages)
├─ Ulimits
│ ├─ Max open files: 1048576
│ ├─ Max processes: 257698
│ ├─ Stack size: 8388608 bytes
│ └─ Core file size: unlimited
└─ DYN_* environment variables
├─ DYN_VAR1=value1
└─ DYN_VAR2=value2
Usage:
python deploy/sanity_check.py [--thorough-check] [--terse] [--runtime-check-only] [--json-output]
Options:
--thorough-check Enable thorough checking (file permissions, directory sizes, disk space, ulimits, CUDA/NVIDIA info, DYN_* env, HuggingFace model details)
--terse Enable terse output mode (show only essential info and errors)
--json-output Output a JSON representation (terse subset) suitable for copy/paste
--runtime-check-only Skip compile-time dependency checks (Rust, Cargo, Maturin) for runtime containers
and validate ai-dynamo packages (ai-dynamo-runtime and ai-dynamo)
--no-gpu-check Skip GPU detection and information collection (useful for environments without GPU access)
--no-framework-check Skip LLM framework package checks (vllm, sglang, tensorrt_llm)
"""
import datetime
import glob
import json
import logging
import os
import platform
import resource
import shutil
import subprocess
import sys
from dataclasses import dataclass, field
from enum import Enum
from typing import Any, Dict, List, Optional, Tuple
# Path constants
DYNAMO_RUNTIME_SRC_PATH = "lib/bindings/python/src/dynamo"
# ANSI color constants
class Colors:
"""ANSI color escape sequences for terminal output."""
RESET = "\033[0m"
BRIGHT_RED = "\033[38;5;196m"
class NodeStatus(Enum):
"""Status of a tree node"""
OK = "ok" # ✅ Success/available
ERROR = "error" # ❌ Error/not found
WARNING = "warn" # ⚠️ Warning
INFO = "info" # No symbol, just information
NONE = "none" # No status indicator
UNKNOWN = "unknown" # ❓ Unknown/not found
@dataclass
class NodeInfo:
"""Base class for all information nodes in the tree structure"""
# Core properties
label: str # Main text/description
desc: Optional[str] = None # Primary value/description
status: NodeStatus = NodeStatus.NONE # Status indicator
# Additional metadata as key-value pairs
metadata: Dict[str, Any] = field(default_factory=dict)
# Tree structure
children: List["NodeInfo"] = field(default_factory=list)
# Display control
show_symbol: bool = True # Whether to show status symbol
def add_child(self, child: "NodeInfo") -> "NodeInfo":
"""Add a child node and return it for chaining"""
self.children.append(child)
return child
def add_metadata(self, key: str, value: str) -> "NodeInfo":
"""Add metadata key-value pair"""
self.metadata[key] = value
return self
def render(
self, prefix: str = "", is_last: bool = True, is_root: bool = True
) -> List[str]:
"""Render the tree node and its children as a list of strings"""
lines = []
# Determine the connector
if not is_root:
# Check if this is a sub-category item
if self.metadata and self.metadata.get("part_of_previous"):
connector = "│"
else:
connector = "└─" if is_last else "├─"
current_prefix = prefix + connector + " "
else:
current_prefix = ""
# Build the line content
line_parts = []
# Add status symbol
if self.show_symbol and self.status != NodeStatus.NONE:
if self.status == NodeStatus.OK:
line_parts.append("✅")
elif self.status == NodeStatus.ERROR:
line_parts.append("❌")
elif self.status == NodeStatus.WARNING:
line_parts.append("⚠️")
elif self.status == NodeStatus.UNKNOWN:
line_parts.append("❓")
# Add label and value
if self.desc:
line_parts.append(f"{self.label}: {self.desc}")
else:
line_parts.append(self.label)
# Add metadata inline - consistent format for all
if self.metadata:
metadata_items = []
for k, v in self.metadata.items():
# Skip internal metadata that shouldn't be displayed
if k != "part_of_previous":
# Format all metadata consistently as "key=value"
metadata_items.append(f"{k}={v}")
if metadata_items:
# Use consistent separator (comma) for all metadata
metadata_str = ", ".join(metadata_items)
line_parts[-1] += f", {metadata_str}"
# Construct the full line
line_content = " ".join(line_parts)
if current_prefix or line_content:
lines.append(current_prefix + line_content)
# Render children
for i, child in enumerate(self.children):
is_last_child = i == len(self.children) - 1
if is_root:
child_prefix = ""
else:
child_prefix = prefix + (" " if is_last else "│ ")
lines.extend(child.render(child_prefix, is_last_child, False))
return lines
def print_tree(self) -> None:
"""Print the tree to console"""
for line in self.render():
print(line)
def to_json_obj(self) -> Dict[str, Any]:
"""
Convert this node into a JSON-serializable object.
Why: `--json-output` needs a copy/pasteable representation of the tree without
relying on terminal formatting characters or emojis.
"""
def _clean_json_text(text: str) -> str:
# Why: tree output uses emojis and padding for human readability. In
# JSON mode we have explicit `status`, so we strip UI-only prefixes.
text = text.strip()
for prefix in ("✅", "❌", "⚠️", "❓"):
if text.startswith(prefix):
text = text[len(prefix) :].lstrip()
break
if text.startswith("🤖"):
text = text[len("🤖") :].lstrip()
return text.strip()
obj: Dict[str, Any] = {"label": _clean_json_text(self.label)}
if self.desc is not None:
obj["desc"] = _clean_json_text(self.desc)
# Keep status stable and machine-friendly.
# NOTE: `NodeStatus.INFO` exists but typically doesn't render a symbol.
if self.status != NodeStatus.NONE:
obj["status"] = self.status.value
if self.metadata:
# Exclude internal metadata keys used for rendering.
metadata = {
k: v for k, v in self.metadata.items() if k != "part_of_previous"
}
if metadata:
obj["meta"] = metadata
if self.children:
obj["children"] = [child.to_json_obj() for child in self.children]
return obj
def has_errors(self) -> bool:
"""Check if this node or any of its children have errors"""
# Check if this node has an error
if self.status == NodeStatus.ERROR:
return True
# Recursively check all children
for child in self.children:
if child.has_errors():
return True
return False
def _replace_home_with_var(self, path: str) -> str:
"""Replace home directory with $HOME in path."""
home = os.path.expanduser("~")
if path.startswith(home):
return path.replace(home, "$HOME", 1)
return path
def _is_inside_container(self) -> bool:
"""Check if we're running inside a container."""
# Check for common container indicators
container_indicators = [
# Docker
os.path.exists("/.dockerenv"),
# Podman/containerd
os.path.exists("/run/.containerenv"),
# Check if cgroup contains docker/containerd
self._check_cgroup_for_container(),
# Check environment variables
os.environ.get("container") is not None,
os.environ.get("DOCKER_CONTAINER") is not None,
]
return any(container_indicators)
def _check_cgroup_for_container(self) -> bool:
"""Check cgroup for container indicators."""
try:
with open("/proc/1/cgroup", "r") as f:
content = f.read()
return any(
indicator in content.lower()
for indicator in ["docker", "containerd", "podman", "lxc"]
)
except Exception:
return False
def _get_gpu_container_remedies(self) -> str:
"""Get remedies for GPU issues when running inside a container."""
return "maybe try a docker restart?"
def _format_timestamp_pdt(self, timestamp: float) -> str:
"""Format timestamp as PDT time string."""
dt_utc = datetime.datetime.fromtimestamp(timestamp, tz=datetime.timezone.utc)
# Convert to PDT (UTC-7)
dt_pdt = dt_utc - datetime.timedelta(hours=7)
return dt_pdt.strftime("%Y-%m-%d %H:%M:%S PDT")
class SystemInfo(NodeInfo):
"""Root node for system information"""
def __init__(
self,
hostname: Optional[str] = None,
thorough_check: bool = False,
terse: bool = False,
runtime_check: bool = False,
no_gpu_check: bool = False,
no_framework_check: bool = False,
):
self.thorough_check = thorough_check
self.terse = terse
self.runtime_check = runtime_check
self.no_gpu_check = no_gpu_check
self.no_framework_check = no_framework_check
if hostname is None:
hostname = platform.node()
# Get IP address
ip_address = self._get_ip_address()
# Format label with hostname and IP
if ip_address:
label = f"System info (hostname={hostname}, IP={ip_address})"
else:
label = f"System info (hostname={hostname})"
super().__init__(label=label, status=NodeStatus.INFO)
# Suppress Prometheus endpoint warnings from planner module
self._suppress_planner_warnings()
# Collect and add all system information
# Always show: OS, User, GPU, Framework, Dynamo
os_info = OSInfo()
# Put execution context and build SHA directly under OS for quick triage when
# scanning logs.
os_info.add_child(
NodeInfo(
label="Execution context",
desc="container"
if self._is_inside_container()
else "host (non-docker)",
status=NodeStatus.INFO,
)
)
dynamo_commit_sha = os.environ.get("DYNAMO_COMMIT_SHA")
os_info.add_child(
NodeInfo(
label="DYNAMO_COMMIT_SHA",
desc=dynamo_commit_sha.strip() if dynamo_commit_sha else "not set",
status=NodeStatus.INFO,
)
)
# Attach host/container context directly under OS (no wrapper node), so it is
# visible near the top when copy/pasting logs.
os_info.add_child(self._dev_shm_info_node())
indicators = self._container_indicators_node()
if indicators is not None:
os_info.add_child(indicators)
selected_env = self._selected_env_node()
if selected_env is not None:
os_info.add_child(selected_env)
if self.thorough_check:
dyn_env = self._dyn_env_node()
if dyn_env is not None:
os_info.add_child(dyn_env)
os_info.add_child(self._ulimit_info_node())
self.add_child(os_info)
self.add_child(UserInfo())
# Add GPU info (always show, even if not found) unless --no-gpu-check or --no-framework-check
# (GPU is primarily for framework usage, so skip if frameworks are skipped)
if not self.no_gpu_check and not self.no_framework_check:
gpu_info = GPUInfo(thorough_check=self.thorough_check)
self.add_child(gpu_info)
# Add Framework info (vllm, sglang, tensorrt_llm)
self.add_child(FrameworkInfo(no_framework_check=self.no_framework_check))
# In terse mode, only add other components if they have errors
if not self.terse:
# Add file permissions check
self.add_child(
FilePermissionsInfo(
thorough_check=self.thorough_check, runtime_check=self.runtime_check
)
)
# Add HuggingFace cache check
self.add_child(HuggingFaceInfo(thorough_check=self.thorough_check))
# Skip compile-time dependencies in runtime-check mode
if not self.runtime_check:
# Add Cargo (always show, even if not found)
self.add_child(CargoInfo(thorough_check=self.thorough_check))
# Add Maturin (Python-Rust build tool)
self.add_child(MaturinInfo())
# Add Python info
self.add_child(PythonInfo(runtime_check=self.runtime_check))
else:
# In terse mode, only add components that have errors
self._add_error_only_components()
# Add Dynamo workspace info (always show, even if not found)
self.add_child(
DynamoInfo(
thorough_check=self.thorough_check, runtime_check=self.runtime_check
)
)
def _dev_shm_info_node(self) -> NodeInfo:
"""Report /dev/shm sizing and mount options (common source of container issues)."""
path = "/dev/shm"
if not os.path.exists(path):
return NodeInfo(
label="Shared memory (/dev/shm)",
desc="not present",
status=NodeStatus.WARNING,
)
status = NodeStatus.INFO
desc = path
try:
st = os.statvfs(path)
total = st.f_frsize * st.f_blocks
avail = st.f_frsize * st.f_bavail
used = max(total - avail, 0)
def _fmt_gib(n: int) -> str:
return f"{(n / (1024**3)):.2f} GiB"
desc = f"{_fmt_gib(used)}/{_fmt_gib(total)} used (avail {_fmt_gib(avail)})"
# Heuristic: small /dev/shm is a common default in Docker and can break
# shared-memory heavy workloads.
if total < 1 * 1024**3:
status = NodeStatus.WARNING
except Exception:
desc = "unable to statvfs"
status = NodeStatus.WARNING
node = NodeInfo(label="Shared memory (/dev/shm)", desc=desc, status=status)
node.add_metadata("writable", str(os.access(path, os.W_OK)).lower())
# Best-effort mount info from /proc/mounts (stdlib only).
try:
with open("/proc/mounts", "r") as f:
for line in f:
parts = line.split()
if len(parts) >= 4 and parts[1] == path:
node.add_metadata("fstype", parts[2])
node.add_metadata("opts", parts[3])
break
except Exception:
pass
return node
def _container_indicators_node(self) -> Optional[NodeInfo]:
"""Return a node describing container indicators, or None if none are present."""
indicators = NodeInfo(label="Container indicators", status=NodeStatus.INFO)
if os.path.exists("/.dockerenv"):
indicators.add_metadata("dockerenv", "true")
if os.path.exists("/run/.containerenv"):
indicators.add_metadata("containerenv", "true")
container_env = os.environ.get("container")
if container_env is not None and container_env != "":
indicators.add_metadata("container", container_env)
docker_container_env = os.environ.get("DOCKER_CONTAINER")
if docker_container_env is not None and docker_container_env != "":
indicators.add_metadata("DOCKER_CONTAINER", docker_container_env)
if not indicators.metadata:
return None
return indicators
def _selected_env_node(self) -> Optional[NodeInfo]:
"""Return a small set of env vars that are often relevant for debugging."""
env_node = NodeInfo(label="Selected env", status=NodeStatus.INFO)
for k in [
"DYNAMO_HOME",
"CUDA_VISIBLE_DEVICES",
"NVIDIA_VISIBLE_DEVICES",
"NVIDIA_DRIVER_CAPABILITIES",
"DYN_SYSTEM_PORT",
]:
v = os.environ.get(k)
if v is not None and v != "":
env_node.add_metadata(k, v)
if not env_node.metadata:
return None
return env_node
def _dyn_env_node(self) -> Optional[NodeInfo]:
"""Return all DYN_* env vars, one per line, or None if none are set."""
dyn_env = {k: v for k, v in os.environ.items() if k.startswith("DYN_")}
if not dyn_env:
return None
dyn_env_node = NodeInfo(
label="DYN_* env",
desc=f"{len(dyn_env)} variables",
status=NodeStatus.INFO,
)
for k in sorted(dyn_env.keys()):
v = dyn_env.get(k)
if v is None:
continue
dyn_env_node.add_child(NodeInfo(label=k, desc=v, status=NodeStatus.INFO))
return dyn_env_node
def _ulimit_info_node(self) -> NodeInfo:
"""Summarize key RLIMITs (similar to `ulimit`) using stdlib only."""
node = NodeInfo(label="Ulimits", status=NodeStatus.INFO)
def _fmt_limit(value: int) -> str:
# resource.RLIM_INFINITY is typically a very large integer.
if value == resource.RLIM_INFINITY:
return "unlimited"
return str(value)
# Keep this list small and high-signal for serving workloads.
limits: List[Tuple[str, int]] = [
("nofile", resource.RLIMIT_NOFILE),
("nproc", resource.RLIMIT_NPROC),
("memlock", resource.RLIMIT_MEMLOCK),
("stack", resource.RLIMIT_STACK),
("core", resource.RLIMIT_CORE),
]
for name, rlim in limits:
try:
soft, hard = resource.getrlimit(rlim)
node.add_metadata(name, f"{_fmt_limit(soft)}:{_fmt_limit(hard)}")
except Exception:
# Avoid failing sanity_check on platforms/containers that restrict access.
pass
return node
def _get_ip_address(self) -> Optional[str]:
"""Get the primary IP address of the system."""
try:
import socket
# Get hostname
hostname = socket.gethostname()
# Get IP address
ip_address = socket.gethostbyname(hostname)
# Filter out localhost
if ip_address.startswith("127."):
# Try to get external IP by connecting to a public DNS
s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
try:
# Connect to Google DNS (doesn't actually send data)
s.connect(("8.8.8.8", 80))
ip_address = s.getsockname()[0]
finally:
s.close()
return ip_address
except Exception:
return None
def _suppress_planner_warnings(self) -> None:
"""Suppress Prometheus endpoint warnings from planner module during import testing."""
# The planner module logs a warning about Prometheus endpoint when imported
# outside of a Kubernetes cluster. Suppress this for cleaner output.
planner_logger = logging.getLogger("dynamo.planner.defaults")
planner_logger.setLevel(logging.ERROR)
# Also suppress the defaults._get_default_prometheus_endpoint logger
defaults_logger = logging.getLogger("defaults._get_default_prometheus_endpoint")
defaults_logger.setLevel(logging.ERROR)
def _add_error_only_components(self) -> None:
"""In terse mode, only add components that have errors"""
# Create components and check their status
components_to_check = [
(
"File System",
FilePermissionsInfo(
thorough_check=self.thorough_check, runtime_check=self.runtime_check
),
),
("Python", PythonInfo(runtime_check=self.runtime_check)),
]
# Skip compile-time dependencies in runtime-check mode
if not self.runtime_check:
components_to_check.extend(
[
("Cargo", CargoInfo(thorough_check=self.thorough_check)),
("Maturin", MaturinInfo()),
]
)
for name, component in components_to_check:
# Only add if the component has an error status
if component.status == NodeStatus.ERROR:
self.add_child(component)
class UserInfo(NodeInfo):
"""User information"""
def __init__(self):
# Get user info
username = os.getenv("USER") or os.getenv("LOGNAME") or "unknown"
if username == "unknown":
try:
import pwd
username = pwd.getpwuid(os.getuid()).pw_name
except Exception:
try:
import subprocess
result = subprocess.run(
["whoami"], capture_output=True, text=True, timeout=5
)
if result.returncode == 0:
username = result.stdout.strip()
except Exception:
pass
uid = os.getuid()
gid = os.getgid()
desc = f"user={username}, uid={uid}, gid={gid}"
# Add warning if running as root
status = NodeStatus.WARNING if uid == 0 else NodeStatus.INFO
if uid == 0:
desc += " ⚠️"
super().__init__(label="User info", desc=desc, status=status)
class OSInfo(NodeInfo):
"""Operating system information"""
def __init__(self):
# Collect OS information
uname = platform.uname()
# Try to get distribution info
distro = ""
version = ""
try:
if os.path.exists("/etc/os-release"):
with open("/etc/os-release", "r") as f:
for line in f:
if line.startswith("NAME="):
distro = line.split("=", 1)[1].strip().strip('"')
elif line.startswith("VERSION="):
version = line.split("=", 1)[1].strip().strip('"')
except Exception:
pass
# Get memory info
mem_used_gb = None
mem_total_gb = None
try:
with open("/proc/meminfo", "r") as f:
meminfo = {}
for line in f:
if ":" in line:
k, v = line.split(":", 1)
meminfo[k.strip()] = v.strip()
if "MemTotal" in meminfo and "MemAvailable" in meminfo:
total_kb = float(meminfo["MemTotal"].split()[0])
avail_kb = float(meminfo["MemAvailable"].split()[0])
mem_used_gb = (total_kb - avail_kb) / (1024 * 1024)
mem_total_gb = total_kb / (1024 * 1024)
except Exception:
pass
# Get CPU cores
cores = os.cpu_count()
# Build the value string
if distro:
value = f"{distro} {version} ({uname.system} {uname.release} {uname.machine})".strip()
else:
value = f"{uname.system} {uname.release} {uname.machine}"
super().__init__(label="OS", desc=value, status=NodeStatus.INFO)
# Add memory and cores as metadata
if mem_used_gb is not None and mem_total_gb is not None:
self.add_metadata("Memory", f"{mem_used_gb:.1f}/{mem_total_gb:.1f} GiB")
if mem_total_gb > 0 and (mem_used_gb / mem_total_gb) >= 0.9:
self.status = NodeStatus.WARNING
if cores:
self.add_metadata("Cores", str(cores))
class GPUInfo(NodeInfo):
"""NVIDIA GPU information.
Displays GPU model, driver version, power/memory stats, and CUDA versions.
In thorough mode (--thorough-check), also collects detailed CUDA/NVIDIA
environment information (nvcc, env vars, dpkg packages, pip packages).
"""
def __init__(self, thorough_check: bool = False):
self.thorough_check = thorough_check
# Find nvidia-smi executable (check multiple paths)
nvidia_smi = shutil.which("nvidia-smi")
if not nvidia_smi:
# Check common paths if `which` fails
for candidate in [
"/usr/bin/nvidia-smi",
"/usr/local/bin/nvidia-smi",
"/usr/local/nvidia/bin/nvidia-smi",
]:
if os.path.exists(candidate) and os.access(candidate, os.X_OK):
nvidia_smi = candidate
break
if not nvidia_smi:
super().__init__(
label="NVIDIA GPU", desc="nvidia-smi not found", status=NodeStatus.ERROR
)
return
try:
# Get GPU list
result = subprocess.run(
[nvidia_smi, "-L"], capture_output=True, text=True, timeout=10
)
if result.returncode != 0:
# Extract and process error message from stderr or stdout
error_msg = "nvidia-smi failed"
# Try stderr first, then stdout
for output in [result.stderr, result.stdout]:
if output and output.strip():
error_lines = output.strip().splitlines()
if error_lines:
error_msg = error_lines[0].strip()
break
# Handle NVML-specific errors
if "Failed to initialize NVML" in error_msg:
error_msg = "No NVIDIA GPU detected (NVML initialization failed)"
# Add docker restart suggestion specifically for NVML failures in containers
if self._is_inside_container():
error_msg += " - maybe try a docker restart?"
super().__init__(
label="NVIDIA GPU", desc=error_msg, status=NodeStatus.ERROR
)
return
# Parse GPU names
gpu_names = []
lines = result.stdout.strip().splitlines()
for line in lines:
# Example: "GPU 0: NVIDIA A100-SXM4-40GB (UUID: GPU-...)"
if ":" in line:
gpu_name = line.split(":", 1)[1].split("(")[0].strip()
gpu_names.append(gpu_name)
# Check for zero GPUs
if not gpu_names:
# Get driver and CUDA even for zero GPUs
driver, cuda = self._get_driver_cuda_versions(nvidia_smi)
driver_cuda_str = ""
if driver or cuda:
parts = []
if driver:
parts.append(f"driver {driver}")
if cuda:
parts.append(f"CUDA {cuda}")
driver_cuda_str = f", {', '.join(parts)}"
super().__init__(
label="NVIDIA GPU",
desc=f"not detected{driver_cuda_str}",
status=NodeStatus.ERROR,
)
return
# Get driver and CUDA versions
driver, cuda = self._get_driver_cuda_versions(nvidia_smi)
# Handle single vs multiple GPUs
if len(gpu_names) == 1:
# Single GPU - just show GPU name in main label
value = gpu_names[0]
super().__init__(label="NVIDIA GPU", desc=value, status=NodeStatus.OK)
# Add power and memory metadata for single GPU
self._add_power_memory_info(nvidia_smi, 0)
else:
# Multiple GPUs - show count in main label
value = f"{len(gpu_names)} GPUs"
super().__init__(label="NVIDIA GPU", desc=value, status=NodeStatus.OK)
# Add each GPU as a child node
for i, name in enumerate(gpu_names):
gpu_child = NodeInfo(
label=f"GPU {i}", desc=name, status=NodeStatus.OK
)
# Add power and memory for this specific GPU
power_mem = self._get_power_memory_string(nvidia_smi, i)
if power_mem:
gpu_child.add_metadata("Stats", power_mem)
self.add_child(gpu_child)
# Add nvidia-smi (driver max CUDA) and nvcc (installed toolkit) info
self._add_cuda_version_children(cuda, driver)
# Add CUDA/NVIDIA info in thorough mode
if self.thorough_check:
cuda_info = self._collect_cuda_info()
self.add_child(cuda_info)
except Exception:
super().__init__(
label="NVIDIA GPU", desc="detection failed", status=NodeStatus.ERROR
)
def _get_driver_cuda_versions(
self, nvidia_smi: str
) -> Tuple[Optional[str], Optional[str]]:
"""Get NVIDIA driver and CUDA versions using query method."""
driver, cuda = None, None
try:
# Use query method for more reliable detection
result = subprocess.run(
[nvidia_smi, "--query-gpu=driver_version", "--format=csv,noheader"],
capture_output=True,
text=True,
timeout=10,
)
if result.returncode == 0 and result.stdout.strip():
driver = result.stdout.strip().splitlines()[0].strip()
# Try to get CUDA version from nvidia-smi output
result = subprocess.run(
[nvidia_smi], capture_output=True, text=True, timeout=10
)
if result.returncode == 0:
import re
m = re.search(r"CUDA Version:\s*([0-9.]+)", result.stdout)
if m:
cuda = m.group(1)
except Exception:
pass
return driver, cuda
def _add_cuda_version_children(
self, driver_cuda: Optional[str], driver_version: Optional[str]
):
"""Add child nodes showing driver, nvidia-smi (driver max) and nvcc (installed toolkit) versions."""
import re
# Add driver version
if driver_version:
driver_node = NodeInfo(
label="Driver version",
desc=driver_version,
status=NodeStatus.INFO,
)
self.add_child(driver_node)
# Add nvidia-smi CUDA version (driver's max supported version)
if driver_cuda:
smi_node = NodeInfo(
label="nvidia-smi CUDA",
desc=f"{driver_cuda} (driver max supported)",
status=NodeStatus.INFO,
)
self.add_child(smi_node)
# Add nvcc version (installed CUDA toolkit)
try:
result = subprocess.run(
["nvcc", "--version"],
capture_output=True,
text=True,
timeout=10,
)
if result.returncode == 0:
# Extract version from output like "release 12.9, V12.9.41"
m = re.search(r"release\s+([0-9.]+)", result.stdout, re.IGNORECASE)
if m:
nvcc_version = m.group(1)
nvcc_node = NodeInfo(
label="nvcc CUDA",
desc=f"{nvcc_version} (installed toolkit)",
status=NodeStatus.INFO,
)
self.add_child(nvcc_node)
else:
nvcc_node = NodeInfo(
label="nvcc CUDA",
desc="version not detected",
status=NodeStatus.WARNING,
)
self.add_child(nvcc_node)
else:
nvcc_node = NodeInfo(
label="nvcc CUDA",
desc="nvcc not found",
status=NodeStatus.INFO,
)
self.add_child(nvcc_node)
except Exception:
# nvcc not available (not an error, just info)
pass
def _add_power_memory_info(self, nvidia_smi: str, gpu_index: int = 0):
"""Add power and memory metadata for a specific GPU."""
power_mem = self._get_power_memory_string(nvidia_smi, gpu_index)
if power_mem:
# Split into Power and Memory parts
if "; " in power_mem:
parts = power_mem.split("; ")
for part in parts:
if part.startswith("Power:"):
self.add_metadata("Power", part.replace("Power: ", ""))
elif part.startswith("Memory:"):
self.add_metadata("Memory", part.replace("Memory: ", ""))
def _get_power_memory_string(
self, nvidia_smi: str, gpu_index: int = 0
) -> Optional[str]:
"""Get power and memory info string for a specific GPU."""
try:
result = subprocess.run(
[
nvidia_smi,
"--query-gpu=power.draw,power.limit,memory.used,memory.total",
"--format=csv,noheader,nounits",
],
capture_output=True,
text=True,
timeout=10,
)
if result.returncode == 0 and result.stdout.strip():
lines = result.stdout.strip().splitlines()
if gpu_index < len(lines):
parts = lines[gpu_index].split(",")
if len(parts) >= 4:
power_draw = parts[0].strip()
power_limit = parts[1].strip()
mem_used = parts[2].strip()
mem_total = parts[3].strip()
info_parts = []
if power_draw and power_limit:
info_parts.append(f"Power: {power_draw}/{power_limit} W")
if mem_used and mem_total:
# Add warning if memory usage is 90% or higher
warning = ""
try:
if float(mem_used) / float(mem_total) >= 0.9:
warning = " ⚠️"
except Exception:
pass
info_parts.append(
f"Memory: {mem_used}/{mem_total} MiB{warning}"
)
if info_parts:
return "; ".join(info_parts)
except Exception:
pass
return None
def _collect_cuda_info(self) -> NodeInfo:
"""
Collect and display CUDA/NVIDIA environment and package information.
This function gathers diagnostic information from multiple sources:
- nvidia-smi: Driver version and maximum supported CUDA version
- nvcc: Installed CUDA toolkit version
- Environment variables: CUDA_VERSION, NV_CUDA_*, NVIDIA_REQUIRE_CUDA
- dpkg: Installed CUDA packages (cuda-*, libcublas*, libnccl*)
- pip: CUDA-related Python packages (torch, nvidia-*, etc.)
Returns:
NodeInfo with collected CUDA/NVIDIA information (INFO status, no validation)
"""
import re
def sh(cmd: str) -> str:
"""Run command and return stdout only."""
try:
p = subprocess.run(
["bash", "-c", f"{cmd} 2>/dev/null"],
stdout=subprocess.PIPE,
text=True,
check=False,
timeout=10,
)
return (p.stdout or "").strip()
except Exception:
return ""
# Define signals to collect
signals = [
("nvidia-smi", "nvidia-smi | grep 'CUDA Version'"),
("nvcc", "nvcc --version | grep -i 'release' || nvcc --version"),
("CUDA_VERSION", "env | grep -i '^CUDA_VERSION='"),
("NV_CUDA_CUDART_VERSION", "env | grep -i '^NV_CUDA_CUDART_VERSION='"),
("NV_CUDA_LIB_VERSION", "env | grep -i '^NV_CUDA_LIB_VERSION='"),
("NV_LIBNCCL_PACKAGE", "env | grep -i '^NV_LIBNCCL_PACKAGE='"),
("NVIDIA_REQUIRE_CUDA", "env | grep -i '^NVIDIA_REQUIRE_CUDA='"),
("dpkg:cuda-*", "dpkg -l | grep -E '^(ii|hi)\\s+cuda-.*-[1-9][0-9]-'"),
(
"dpkg:libcublas/libnccl",
"dpkg -l | grep -E '^(ii|hi)\\s+lib(cublas|nccl).*-[1-9][0-9]-'",
),
(
"pip:cuda-related",
"python -m pip list --format=freeze | grep -Ei '(cuda|cudnn|nccl|nvshmem|\\+cu[1-9][0-9]|-cu[1-9][0-9]|^(torch|torchaudio|torchvision)==)'",
),
]
node = NodeInfo(
label="CUDA/NVIDIA Information",
desc="",
status=NodeStatus.INFO,
)
has_any_output = False
for label, cmd in signals:
out = sh(cmd)
lines = [ln.strip() for ln in out.splitlines() if ln.strip()]
if not lines:
continue
has_any_output = True
# Special handling for nvidia-smi: extract key info
if label == "nvidia-smi":
ln = lines[0]
parts = []
if m := re.search(r"NVIDIA-SMI\s+([\d.]+)", ln):
parts.append(f"NVIDIA-SMI {m.group(1)}")
if m := re.search(r"Driver Version:\s+([\d.]+)", ln):
parts.append(f"Driver {m.group(1)}")
if m := re.search(r"CUDA Version:\s+([\d.]+)", ln):
parts.append(f"CUDA {m.group(1)}")
desc = ", ".join(parts) if parts else ln.strip("|").strip()
signal_node = NodeInfo(label=label, desc=desc, status=NodeStatus.INFO)
node.add_child(signal_node)
# Single-line outputs (nvcc and env vars)
elif label in (
"nvcc",
"CUDA_VERSION",
"NV_CUDA_CUDART_VERSION",
"NV_CUDA_LIB_VERSION",
"NV_LIBNCCL_PACKAGE",
):
signal_node = NodeInfo(
label=label, desc=lines[0], status=NodeStatus.INFO
)
node.add_child(signal_node)
# Multi-line outputs with truncation
elif label == "NVIDIA_REQUIRE_CUDA":
ln = lines[0]
if len(ln) > 200 and "cuda>=" in ln.lower():
m = re.search(r"(cuda>=[\d.]+)", ln, re.IGNORECASE)
if m:
ln = f"{ln.split('=')[0]}={m.group(1)} ..."
else:
ln = ln[:200] + "..."
signal_node = NodeInfo(label=label, desc=ln, status=NodeStatus.INFO)
node.add_child(signal_node)
# Multi-line outputs (dpkg, pip)
else:
signal_node = NodeInfo(label=label, desc="", status=NodeStatus.INFO)
for ln in lines:
line_node = NodeInfo(
label=ln, status=NodeStatus.NONE, show_symbol=False
)
signal_node.add_child(line_node)
node.add_child(signal_node)
if not has_any_output:
node.desc = "no CUDA/NVIDIA information detected"
return node
class FilePermissionsInfo(NodeInfo):
"""File system check for development environment directories
Checks writability of critical directories needed for:
- Dynamo development (top-level dynamo directory)
- Rust development (Cargo target directory + all files, RUSTUP_HOME, CARGO_HOME) - skipped in runtime_check mode
- Python development (site-packages)
In thorough mode, also checks disk space for the dynamo working directory
and shows a warning if less than 10% free space is available.
In fast mode, skips recursive file checking in Cargo target directory
for improved performance on large target directories.
In runtime_check mode, skips Rust/Cargo toolchain checks.
"""
def __init__(self, thorough_check: bool = False, runtime_check: bool = False):
super().__init__(label="File System", status=NodeStatus.INFO)
self.thorough_check = thorough_check
self.runtime_check = runtime_check
# Check top-level dynamo directory
self._check_dynamo_directory_permissions()
# Skip Rust toolchain checks in runtime-check mode
if not self.runtime_check:
# Check Rust toolchain directories (RUSTUP_HOME and CARGO_HOME)
self._check_rust_toolchain_permissions()
# Check Cargo target directory (with optional recursive file checking)
self._check_cargo_target_permissions()
# Check Python site-packages directory
self._check_site_packages_permissions()
def _check_permissions_unified(
self,
candidate_paths: List[str],
label_prefix: str,
recursive: bool = False,
exclude_files: Optional[List[str]] = None,
) -> List[NodeInfo]:
"""Unified permission checking function
Args:
candidate_paths: List of paths to check, uses first available one
label_prefix: Prefix for the node label
recursive: If True, check all files recursively; if False, check directory only
exclude_files: List of filenames to exclude from file checking (e.g., ['.git'])
Returns:
List of NodeInfo objects for the results
"""
exclude_files = exclude_files or []
results = []
# Find first available path
selected_path = None
for path in candidate_paths:
expanded_path = os.path.expanduser(path)
if os.path.exists(expanded_path):
selected_path = expanded_path
break
if not selected_path:
# No paths exist
path_list = ", ".join(candidate_paths)
results.append(
NodeInfo(
label=f"{label_prefix} (tried: {path_list})",
desc="No candidate paths exist",
status=NodeStatus.ERROR,
)
)
return results
try:
# Check if it's actually a directory
if not os.path.isdir(selected_path):
results.append(
NodeInfo(
label=f"{label_prefix} ({self._replace_home_with_var(selected_path)})",
desc="Path is not a directory",
status=NodeStatus.ERROR,
)
)
return results
# Check if directory is effectively writable
if not self._is_effectively_writable(selected_path):
results.append(
NodeInfo(
label=f"{label_prefix} ({self._replace_home_with_var(selected_path)})",
desc="Directory not writable",
status=NodeStatus.ERROR,
)
)
return results
if not recursive:
# Just check directory writability
# Check if running as root but directory is not owned by root
is_root = os.getuid() == 0
is_root_owned = False
warning_symbol = ""
desc_text = "writable"
owner_name = None
if is_root:
try:
stat_info = os.stat(selected_path)
is_root_owned = stat_info.st_uid == 0
if not is_root_owned:
warning_symbol = " ⚠️"
# Get the owner name
try:
import pwd
owner_name = pwd.getpwuid(stat_info.st_uid).pw_name
except Exception:
owner_name = f"uid={stat_info.st_uid}"
desc_text = f"writable (owned by {owner_name or 'root'})"
except Exception:
desc_text = "writable (owned by unknown)"
# Add disk space info in thorough mode
status = NodeStatus.OK # Default status
if self.thorough_check:
disk_space, disk_warning = self._format_disk_space(selected_path)
desc_text += disk_space
# Override status if disk space is low
if disk_warning:
status = disk_warning
results.append(
NodeInfo(
label=f"{label_prefix} ({self._replace_home_with_var(selected_path)}){warning_symbol}",
desc=desc_text,
status=status,
)
)
else:
# Check files recursively
(
total_files,
non_writable_files,
non_writable_list,
) = self._count_writable_files(
selected_path, recursive=True, exclude_files=exclude_files
)
# Create description based on results
desc, status = self._create_file_count_description(
total_files, non_writable_files, "files"
)
# Check if running as root but directory is not owned by root
is_root = os.getuid() == 0
is_root_owned = False
warning_symbol = ""
owner_name = None
if is_root:
try:
stat_info = os.stat(selected_path)
is_root_owned = stat_info.st_uid == 0
if not is_root_owned:
warning_symbol = " ⚠️"
# Get the owner name
try:
import pwd
owner_name = pwd.getpwuid(stat_info.st_uid).pw_name
except Exception:
owner_name = f"uid={stat_info.st_uid}"
# Modify description to indicate ownership
if "writable" in desc:
desc = desc.replace(
"writable",
f"writable (owned by {owner_name or 'root'})",
)
except Exception:
# Modify description to indicate ownership
if "writable" in desc:
desc = desc.replace(
"writable", "writable (owned by unknown)"
)
# Add disk space info in thorough mode
if self.thorough_check:
disk_space, disk_warning = self._format_disk_space(selected_path)
desc += disk_space
# Override status if disk space is low
if disk_warning:
status = disk_warning
results.append(
NodeInfo(
label=f"{label_prefix} ({self._replace_home_with_var(selected_path)}){warning_symbol}",
desc=desc,
status=status,
)
)
# Add details for non-writable files if there are any (limit to first 10)
if non_writable_files > 0:
details_label = (
f"Non-writable files (showing first 10 of {non_writable_files})"
)
if non_writable_files <= 10:
details_label = f"Non-writable files ({non_writable_files})"
details_node = NodeInfo(
label=details_label,
desc="; ".join(non_writable_list[:10]),
status=NodeStatus.WARNING,
)
results.append(details_node)
except Exception as e:
results.append(
NodeInfo(
label=f"{label_prefix} ({self._replace_home_with_var(selected_path)})",
desc=f"Permission check failed: {str(e)}",
status=NodeStatus.ERROR,
)
)
return results
def _is_effectively_writable(self, file_path: str) -> bool:
"""Check if a file is effectively writable
A file is considered effectively writable if:
1. It's already writable (os.access check)
2. We own the file (can chmod it)
3. We are root (can do anything) - but only if os.access confirms write access
Note: Root may still be denied write access on NFS mounts due to root squashing
"""
try:
# First check if it's already writable - this works for all cases including NFS
if os.access(file_path, os.W_OK):
return True
# Check if we own the file (and can therefore chmod it)
stat_info = os.stat(file_path)
if stat_info.st_uid == os.getuid():
return True
# For root, we still need to respect the os.access result
# Root privileges don't guarantee write access on NFS mounts
# If os.access(W_OK) returned False above, respect that even for root
return False
except Exception:
# If we can't stat the file, assume it's not writable
return False
def _count_writable_files(
self,
directory: str,
recursive: bool = False,
exclude_files: Optional[List[str]] = None,
) -> Tuple[int, int, List[str]]:
"""Count total files and non-writable files in directory
Returns:
Tuple of (total_files, non_writable_files, non_writable_list)
"""
exclude_files = exclude_files or []
total_files = 0
non_writable_files = 0
non_writable_list = []
if recursive:
# Walk through all files in the directory tree recursively
for root, dirs, files in os.walk(directory):
for file in files:
file_path = os.path.join(root, file)
# Skip symbolic links
if os.path.islink(file_path):
continue
total_files += 1
if not self._is_effectively_writable(file_path):
non_writable_files += 1
rel_path = os.path.relpath(file_path, directory)
non_writable_list.append(rel_path)
else:
# Only check files in the immediate directory (non-recursive)
for item in os.listdir(directory):
if item in exclude_files:
continue
item_path = os.path.join(directory, item)
# Skip symbolic links and only check regular files
if os.path.isfile(item_path) and not os.path.islink(item_path):
total_files += 1
try:
if not self._is_effectively_writable(item_path):
non_writable_files += 1
non_writable_list.append(item)
except Exception:
non_writable_files += 1
non_writable_list.append(item)
return total_files, non_writable_files, non_writable_list
def _create_file_count_description(
self, total_files: int, non_writable_files: int, context: str = "files"
) -> Tuple[str, NodeStatus]:
"""Create description and status for file count results"""
if total_files == 0:
return f"writable, no {context} found", NodeStatus.INFO
elif non_writable_files == 0:
return f"writable, all {total_files} {context} writable", NodeStatus.OK
else:
return (
f"writable, {non_writable_files} of {total_files} {context} not writable",
NodeStatus.WARNING,
)
def _get_cargo_target_path_candidates(self) -> List[str]:
"""Get candidate paths for cargo target directory"""
candidates = []
# Try to get target directory from cargo metadata (most accurate)
try:
result = subprocess.run(
["cargo", "metadata", "--format-version=1", "--no-deps"],
capture_output=True,
text=True,
timeout=10,
cwd=".",
)
if result.returncode == 0:
import json
metadata = json.loads(result.stdout)
target_path = metadata.get("target_directory")
if target_path:
candidates.append(target_path)
except Exception:
pass
# Add fallback candidates
cargo_target = os.environ.get("CARGO_TARGET_DIR")
if cargo_target:
candidates.append(cargo_target)
candidates.append("~/.cargo/target")
return candidates
def _check_dynamo_directory_permissions(self):
"""Check top-level dynamo directory and key files writability"""
# Use the existing workspace detection logic
dynamo_root = DynamoInfo.find_workspace()
if not dynamo_root:
# In runtime check mode, workspace not being found is expected
if self.runtime_check:
self.add_child(
NodeInfo(
label="Dynamo workspace",
desc="workspace not found (runtime check does not require a checkout)",
status=NodeStatus.WARNING,
)
)
else:
self.add_child(
NodeInfo(
label="Dynamo workspace",
desc="workspace not found",
status=NodeStatus.ERROR,
)
)
return
if not DynamoInfo.is_dynamo_workspace(dynamo_root):
if self.runtime_check:
self.add_child(
NodeInfo(
label="Dynamo workspace",
desc="not a valid dynamo workspace (runtime check does not require a checkout)",
status=NodeStatus.WARNING,
)
)
return
self.add_child(
NodeInfo(
label="Dynamo workspace",
desc="not a valid dynamo workspace",
status=NodeStatus.ERROR,
)
)
return
# Check dynamo root directory and files (exclude .git)
recursive = self.thorough_check
results = self._check_permissions_unified(
[dynamo_root],
"Dynamo workspace",
recursive=recursive,
exclude_files=[".git"],
)
for result in results:
if self.runtime_check and result.status == NodeStatus.ERROR:
result.status = NodeStatus.WARNING
self.add_child(result)
# Check .git directory separately
git_dir = os.path.join(dynamo_root, ".git")
if os.path.exists(git_dir):
git_results = self._check_permissions_unified(
[git_dir], "Dynamo .git directory", recursive=recursive
)
for result in git_results:
if self.runtime_check and result.status == NodeStatus.ERROR:
result.status = NodeStatus.WARNING
self.add_child(result)
else:
self.add_child(
NodeInfo(
label="Dynamo .git directory",
desc="not available",
status=NodeStatus.WARNING,
)
)
def _check_site_packages_permissions(self):
"""Check site-packages directory writability
Logic:
- If running in a virtualenv and its site-packages is writable: PASS
(system site-packages being read-only is expected and shown as WARNING)
- If no virtualenv and no writable site-packages: ERROR
(can't install packages anywhere)
"""
try:
import site
# Get all candidate site-packages directories
site_packages_dirs = site.getsitepackages()
user_site = site.getusersitepackages()
if user_site:
site_packages_dirs.append(user_site)
# First pass: check which directories are writable
writable_dirs = []
all_results = []
recursive = self.thorough_check
for site_dir in site_packages_dirs:
if os.path.exists(site_dir):
results = self._check_permissions_unified(
[site_dir], "site-packages", recursive=recursive
)
all_results.append((site_dir, results))
# Check if this directory is writable
if results and results[0].status == NodeStatus.OK:
writable_dirs.append(site_dir)
# Determine if we have at least one writable site-packages
has_writable_site_packages = len(writable_dirs) > 0
# Second pass: add results with adjusted status
for site_dir, results in all_results:
for result in results:
# If we have at least one writable site-packages,
# downgrade ERROR to WARNING for non-writable ones
if (
has_writable_site_packages or self.runtime_check
) and result.status == NodeStatus.ERROR:
result.status = NodeStatus.WARNING
self.add_child(result)
except Exception as e:
status = NodeStatus.WARNING if self.runtime_check else NodeStatus.ERROR
self.add_child(
NodeInfo(
label="Python site-packages",
desc=f"Permission check failed: {str(e)}",
status=status,
)
)
def _check_cargo_target_permissions(self):
"""Check Cargo target directory writability and file permissions"""
candidates = self._get_cargo_target_path_candidates()
recursive = self.thorough_check
results = self._check_permissions_unified(
candidates, "Cargo target", recursive=recursive
)
if not results or (
len(results) == 1
and results[0].status == NodeStatus.ERROR
and results[0].desc is not None
and "No candidate paths exist" in results[0].desc
):
# No paths exist - show warning instead of error
self.add_child(
NodeInfo(
label="Cargo target",
desc="Path does not exist",
status=NodeStatus.WARNING,
)
)
else:
for result in results:
self.add_child(result)
def _check_rust_toolchain_permissions(self):
"""Check RUSTUP_HOME and CARGO_HOME directory writability
These directories need recursive checking because:
- RUSTUP_HOME: rustup needs to write toolchain files, documentation, etc.
- CARGO_HOME: cargo needs to write registry cache, git repos, binaries, etc.
"""
# Check RUSTUP_HOME
rustup_env = os.environ.get("RUSTUP_HOME")
rustup_candidates = [rustup_env] if rustup_env is not None else []
rustup_candidates.append("~/.rustup")
recursive = self.thorough_check
rustup_results = self._check_permissions_unified(
rustup_candidates, "Rustup home", recursive=recursive
)
for result in rustup_results:
self.add_child(result)
# Check CARGO_HOME
cargo_env = os.environ.get("CARGO_HOME")
cargo_candidates = [cargo_env] if cargo_env is not None else []
cargo_candidates.append("~/.cargo")
cargo_results = self._check_permissions_unified(
cargo_candidates, "Cargo home", recursive=recursive
)
for result in cargo_results:
self.add_child(result)
def _format_disk_space(self, path: str) -> Tuple[str, Optional[NodeStatus]]:
"""Format disk space information for a given path
Returns:
Tuple of (formatted_string, warning_status_if_low_space)
"""
try:
# Get disk usage statistics
statvfs = os.statvfs(path)
# Calculate sizes in bytes
total_bytes = statvfs.f_frsize * statvfs.f_blocks
free_bytes = statvfs.f_frsize * statvfs.f_bavail
used_bytes = total_bytes - free_bytes
# Convert to human readable format
def format_bytes(bytes_val):
"""Convert bytes to human readable format"""
for unit in ["B", "KB", "MB", "GB", "TB"]:
if bytes_val < 1024.0:
return f"{bytes_val:.1f} {unit}"
bytes_val /= 1024.0
return f"{bytes_val:.1f} PB"
# Calculate percentage used
percent_used = (used_bytes / total_bytes) * 100
percent_free = 100 - percent_used
formatted_string = f", {format_bytes(used_bytes)}/{format_bytes(total_bytes)} ({percent_used:.1f}% used)"
# Return warning status if less than 10% free space
warning_status = NodeStatus.WARNING if percent_free < 10 else None
return formatted_string, warning_status
except Exception:
return "", None
class HuggingFaceInfo(NodeInfo):
"""Hugging Face models cache information (follows standalone requirement)
HARD-CODED PATH: ~/.cache/huggingface/hub
ENV VARIABLES (checked by HuggingFace transformers library, not this tool):
- HF_HOME: Base directory for Hugging Face cache
- HUGGINGFACE_HUB_CACHE: Direct path to hub cache
- HF_TOKEN: Authentication token (checked and displayed if set)
This class directly uses ~/.cache/huggingface/hub instead of reading environment
variables because this tool must work reliably in all environments, including when
environment variables are misconfigured or not set. For dynamic configuration that
respects all HF environment variables, use dynamo.common.config_dump at runtime.
"""
def __init__(self, thorough_check: bool = False):
# HARD-CODED PATH: ~/.cache/huggingface/hub (not reading HF_HOME or HUGGINGFACE_HUB_CACHE)
hf_cache_path = os.path.expanduser("~/.cache/huggingface/hub")
if os.path.exists(hf_cache_path):
models = self._get_cached_models(
hf_cache_path, compute_sizes=thorough_check
)
if models:
self._init_with_models(hf_cache_path, models, thorough_check)
else:
self._init_no_models_found(hf_cache_path)
else:
self._init_cache_not_available()
# Add HF_TOKEN info if set (common to all cases)
self._add_hf_token_info()
def _init_with_models(
self, hf_cache_path: str, models: List[tuple], thorough_check: bool
):
"""Initialize when models are found in cache."""
model_count = len(models)
display_path = self._replace_home_with_var(hf_cache_path)
# Check if cache is on NFS or host mount
mount_type = self._get_mount_type(hf_cache_path)
desc = f"{model_count} models in {display_path}"
if mount_type:
desc += f" ({mount_type})"
super().__init__(
label="Hugging Face Cache",
desc=desc,
status=NodeStatus.OK,
)
# Only show detailed model list in thorough mode
if thorough_check:
self._add_model_details(models)
def _init_no_models_found(self, hf_cache_path: str):
"""Initialize when cache exists but no models found."""
display_path = self._replace_home_with_var(hf_cache_path)
super().__init__(
label="Hugging Face Cache",
desc=f"directory exists but no models found in {display_path}",
status=NodeStatus.WARNING,
)
def _init_cache_not_available(self):
"""Initialize when cache directory doesn't exist."""
super().__init__(
label="Hugging Face Cache",
desc="~/.cache/huggingface/hub not available",
status=NodeStatus.WARNING,
)
def _add_model_details(self, models: List[tuple]):
"""Add detailed model information as child nodes."""
# Add all models as children (no limit)
for i, model_info in enumerate(models):
model_name, download_date, size_str = model_info
model_node = NodeInfo(
label=f"Model {i+1}",
desc=f"{model_name}, downloaded={download_date}, size={size_str}",
status=NodeStatus.INFO,
)
self.add_child(model_node)
def _add_hf_token_info(self):
"""Add HF_TOKEN information if the environment variable is set."""
if os.environ.get("HF_TOKEN"):
token_node = NodeInfo(
label="HF_TOKEN",
desc="<set>",
status=NodeStatus.INFO,
)
self.add_child(token_node)
def _get_mount_type(self, path: str) -> Optional[str]:
"""Determine if path is on NFS or a host mount (bind mount).
Returns:
String describing mount type (e.g., "NFS", "host mount") or None if local
"""
try:
# Read /proc/mounts to find mount info
with open("/proc/mounts", "r") as f:
mounts = f.readlines()
# Find the longest matching mount point (most specific)
abs_path = os.path.abspath(path)
best_match = None
best_match_len = 0
for line in mounts:
parts = line.split()
if len(parts) < 3:
continue
mount_point = parts[1]
fs_type = parts[2]
# Check if our path is under this mount point
if (
abs_path.startswith(mount_point)
and len(mount_point) > best_match_len
):
best_match = (mount_point, fs_type)
best_match_len = len(mount_point)
if best_match:
mount_point, fs_type = best_match
# Check for NFS
if fs_type in ("nfs", "nfs4"):
return "NFS"
# Check for bind mount (host mount in Docker)
# In Docker, bind mounts typically show up with device paths or overlay
if fs_type in ("ext4", "xfs", "btrfs") and mount_point != "/":
# This could be a bind mount from host
# Additional heuristic: check if device is different from root
try:
root_stat = os.stat("/")
path_stat = os.stat(abs_path)
if root_stat.st_dev != path_stat.st_dev:
return "host mount"
except Exception:
pass
return None
except Exception:
return None
def _get_cached_models(self, cache_path: str, compute_sizes: bool) -> List[tuple]:
"""Get list of cached Hugging Face models with metadata.
Args:
cache_path: Path to HuggingFace cache directory
compute_sizes: Whether to compute directory sizes (slow operation)
Returns:
List of tuples: (model_name, download_date, size_str)
"""
models = []
try:
if os.path.exists(cache_path):
for item in os.listdir(cache_path):
item_path = os.path.join(cache_path, item)
# Only count model repos; ignore datasets--, spaces--, blobs, etc.
if not (os.path.isdir(item_path) and item.startswith("models--")):
continue
# Convert "models--org--repo-name" to "org/repo-name"
parts = item.split("--")
if len(parts) >= 3:
org = parts[1]
model_name = "--".join(parts[2:]) # Preserve dashes
display_name = f"{org}/{model_name}"
else:
display_name = item # Fallback to raw dir name
# Get download date (directory creation/modification time)
try:
stat_info = os.stat(item_path)
# Use the earlier of creation time or modification time
download_time = min(stat_info.st_ctime, stat_info.st_mtime)
download_date = self._format_timestamp_pdt(download_time)
except Exception:
download_date = "unknown"
# Get directory size (only when requested)
size_str = "-"
if compute_sizes:
try:
size_bytes = self._get_directory_size_bytes(item_path)
size_str = self._format_size(size_bytes)
except Exception:
size_str = "unknown"
models.append((display_name, download_date, size_str))
except Exception:
pass
# Sort by model name
return sorted(models, key=lambda x: x[0])
def _get_directory_size_bytes(self, directory: str) -> int:
"""Get the total size of a directory in bytes."""
total_size = 0
try:
for dirpath, dirnames, filenames in os.walk(directory):
for filename in filenames:
filepath = os.path.join(dirpath, filename)
try:
if not os.path.islink(filepath): # Skip symbolic links
total_size += os.path.getsize(filepath)
except (OSError, FileNotFoundError):
pass # Skip files that can't be accessed
except Exception:
pass
return total_size
def _format_size(self, size_bytes: int) -> str:
"""Format size in bytes to human readable format."""
if size_bytes == 0:
return "0 B"
units = ["B", "KB", "MB", "GB", "TB"]
size = float(size_bytes)
unit_index = 0
while size >= 1024.0 and unit_index < len(units) - 1:
size /= 1024.0
unit_index += 1
# Format with appropriate precision
if unit_index == 0: # Bytes
return f"{int(size)} {units[unit_index]}"
elif size >= 100:
return f"{size:.0f} {units[unit_index]}"
elif size >= 10:
return f"{size:.1f} {units[unit_index]}"
else:
return f"{size:.2f} {units[unit_index]}"
class CargoInfo(NodeInfo):
"""Cargo tool information"""
def __init__(self, thorough_check: bool = False):
self.thorough_check = thorough_check
cargo_path = shutil.which("cargo")
cargo_version = None
# Get cargo version
if cargo_path:
try:
result = subprocess.run(
["cargo", "--version"], capture_output=True, text=True, timeout=5
)
if result.returncode == 0:
cargo_version = result.stdout.strip()
except Exception:
pass
if not cargo_path and not cargo_version:
super().__init__(
label="Cargo",
desc="not found, install Rust toolchain to see cargo target directory",
status=NodeStatus.ERROR,
)
return
# Initialize with cargo path and version
value = ""
if cargo_path:
value = self._replace_home_with_var(cargo_path)
if cargo_version:
value += f", {cargo_version}" if value else cargo_version
super().__init__(label="Cargo", desc=value, status=NodeStatus.OK)
# Get cargo home directory from the environment (may not exist, which is OK)
cargo_home_env = os.environ.get("CARGO_HOME")
if cargo_home_env:
cargo_home = cargo_home_env
home_value = f"CARGO_HOME={self._replace_home_with_var(cargo_home)}"
else:
cargo_home = os.path.expanduser("~/.cargo")
home_value = (
f"CARGO_HOME=<not set>, using {self._replace_home_with_var(cargo_home)}"
)
if cargo_home and os.path.exists(cargo_home):
status = NodeStatus.INFO
else:
home_value += " (directory does not exist)"
status = NodeStatus.WARNING
home_node = NodeInfo(
label="Cargo home directory", desc=home_value, status=status
)
self.add_child(home_node)
# Get cargo target directory
cargo_target_env = os.environ.get("CARGO_TARGET_DIR")
cargo_target = self._get_cargo_target_directory()
# Calculate total directory size (only if thorough check and directory exists)
size_str = ""
if cargo_target and os.path.exists(cargo_target) and self.thorough_check:
total_size_gb = self._get_directory_size_gb(cargo_target)
size_str = f", {total_size_gb:.1f} GB" if total_size_gb is not None else ""
# Format the display value
if cargo_target_env:
display_cargo_target = (
self._replace_home_with_var(cargo_target) if cargo_target else "unknown"
)
target_value = f"CARGO_TARGET_DIR={display_cargo_target}{size_str}"
else:
display_cargo_target = (
self._replace_home_with_var(cargo_target) if cargo_target else "unknown"
)
target_value = (
f"CARGO_TARGET_DIR=<not set>, using {display_cargo_target}{size_str}"
)
# Check directory existence and set status
if cargo_target and os.path.exists(cargo_target):
status = NodeStatus.INFO
target_node = NodeInfo(
label="Cargo target directory",
desc=target_value,
status=status,
)
self.add_child(target_node)
# Add debug/release/binary info as children of target directory
self._add_build_info(target_node, cargo_target)
else:
target_value += " (directory does not exist)"
status = NodeStatus.WARNING if cargo_target_env else NodeStatus.INFO
target_node = NodeInfo(
label="Cargo target directory",
desc=target_value,
status=status,
)
self.add_child(target_node)
def _get_directory_size_gb(self, directory: str) -> Optional[float]:
"""Get the size of a directory in GB."""
try:
# Use du command to get directory size in bytes
result = subprocess.run(
["du", "-sb", directory], capture_output=True, text=True, timeout=30
)
if result.returncode == 0:
# Parse output: "size_in_bytes\tdirectory_path"
size_bytes = int(result.stdout.split()[0])
# Convert to GB
size_gb = size_bytes / (1024**3)
return size_gb
except Exception:
pass
return None
def _get_cargo_target_directory(self) -> Optional[str]:
"""Get cargo target directory using cargo metadata."""
try:
# Use DynamoInfo's static method to find workspace
workspace_dir = DynamoInfo.find_workspace()
# Run cargo metadata command to get target directory
cmd_args = ["cargo", "metadata", "--format-version=1", "--no-deps"]
kwargs: Dict[str, Any] = {
"capture_output": True,
"text": True,
"timeout": 10,
}
# Add cwd if workspace_dir was found
if workspace_dir and os.path.isdir(workspace_dir):
kwargs["cwd"] = workspace_dir
result = subprocess.run(cmd_args, **kwargs)
if result.returncode == 0:
# Parse JSON output to extract target_directory
metadata = json.loads(result.stdout)
return metadata.get("target_directory")
except Exception:
pass
return None
def _add_build_info(self, parent_node: NodeInfo, cargo_target: str):
"""Add debug/release/binary information as children of target directory."""
debug_dir = os.path.join(cargo_target, "debug")
release_dir = os.path.join(cargo_target, "release")
# Check debug directory
if os.path.exists(debug_dir):
display_debug = self._replace_home_with_var(debug_dir)
debug_value = display_debug
# Add size (only if thorough check)
if self.thorough_check:
debug_size_gb = self._get_directory_size_gb(debug_dir)
if debug_size_gb is not None:
debug_value += f", {debug_size_gb:.1f} GB"
try:
debug_mtime = os.path.getmtime(debug_dir)
debug_time = self._format_timestamp_pdt(debug_mtime)
debug_value += f", modified={debug_time}"
except Exception:
debug_value += " (unable to read timestamp)"
debug_node = NodeInfo(
label="Debug", desc=debug_value, status=NodeStatus.INFO
)
parent_node.add_child(debug_node)
# Check release directory
if os.path.exists(release_dir):
display_release = self._replace_home_with_var(release_dir)
release_value = display_release
# Add size (only if thorough check)
if self.thorough_check:
release_size_gb = self._get_directory_size_gb(release_dir)
if release_size_gb is not None:
release_value += f", {release_size_gb:.1f} GB"
try:
release_mtime = os.path.getmtime(release_dir)
release_time = self._format_timestamp_pdt(release_mtime)
release_value += f", modified={release_time}"
except Exception:
release_value += " (unable to read timestamp)"
release_node = NodeInfo(
label="Release", desc=release_value, status=NodeStatus.INFO
)
parent_node.add_child(release_node)
# Find *.so file
so_file = self._find_so_file(cargo_target)
if so_file:
display_so = self._replace_home_with_var(so_file)
so_value = display_so
# Add file size (only if thorough check)
if self.thorough_check:
try:
file_size_bytes = os.path.getsize(so_file)
file_size_mb = file_size_bytes / (1024**2)
so_value += f", {file_size_mb:.1f} MB"
except Exception:
pass
try:
so_mtime = os.path.getmtime(so_file)
so_time = self._format_timestamp_pdt(so_mtime)
so_value += f", modified={so_time}"
except Exception:
so_value += " (unable to read timestamp)"
binary_node = NodeInfo(
label="Binary", desc=so_value, status=NodeStatus.INFO
)
parent_node.add_child(binary_node)
def _find_so_file(self, target_directory: str) -> Optional[str]:
"""Find the compiled *.so file in target directory."""
# Check common locations for .so files
search_dirs = [
os.path.join(target_directory, "debug"),
os.path.join(target_directory, "release"),
target_directory,
]
for search_dir in search_dirs:
if not os.path.exists(search_dir):
continue
# Walk through directory looking for .so files
try:
for root, dirs, files in os.walk(search_dir):
for file in files:
if file.endswith(".so"):
return os.path.join(root, file)
# Don't recurse too deep
if root.count(os.sep) - search_dir.count(os.sep) > 2:
dirs[:] = [] # Stop recursion
except Exception:
pass
return None
class MaturinInfo(NodeInfo):
"""Maturin tool information (Python-Rust build tool)"""
def __init__(self):
maturin_path = shutil.which("maturin")
if not maturin_path:
super().__init__(label="Maturin", desc="not found", status=NodeStatus.ERROR)
# Add installation hint as a child node
install_hint = NodeInfo(
label="Install with",
desc="uv pip install maturin[patchelf]",
status=NodeStatus.INFO,
)
self.add_child(install_hint)
return
try:
result = subprocess.run(
["maturin", "--version"], capture_output=True, text=True, timeout=5
)
if result.returncode == 0:
version = result.stdout.strip()
# Include the maturin binary path like Cargo and Git do
display_maturin_path = self._replace_home_with_var(maturin_path)
super().__init__(
label="Maturin",
desc=f"{display_maturin_path}, {version}",
status=NodeStatus.OK,
)
return
except Exception:
pass
super().__init__(label="Maturin", desc="not found", status=NodeStatus.ERROR)
class NixlInfo(NodeInfo):
"""NIXL installation information (Python wheel + native shared library).
Why: NIXL is optional for many deployments, but when enabled it is a common
source of runtime failures (missing wheel, missing libnixl.so, or wrong
library search path). This check reports "not installed" vs "installed +
version" without importing any Dynamo code.
"""
def __init__(self):
# Prefer package metadata over importing nixl, since imports can fail if
# native libs are missing from the dynamic linker path.
dist_versions: Dict[str, str] = {}
try:
import importlib.metadata
import re
# Extensible: discover any installed distribution whose name is:
# - exactly "nixl", or
# - starts with "nixl-" / "nixl_" (e.g. nixl-cu12, nixl-cu13, future nixl-cu14)
#
# Avoids hard-coding CUDA majors here.
nixl_name_re = re.compile(r"^nixl($|[-_].+)", re.IGNORECASE)
for dist in importlib.metadata.distributions():
name = (dist.metadata.get("Name") or "").strip()
if not name or not nixl_name_re.match(name):
continue
dist_versions[name] = dist.version
except ModuleNotFoundError:
# Extremely old Python only. This script targets Python 3.8+ anyway.
dist_versions = {}
# Check whether the native shared library is loadable.
libnixl_ok = False
libnixl_err: Optional[str] = None
try:
import ctypes
ctypes.CDLL("libnixl.so")
libnixl_ok = True
except OSError as e:
libnixl_err = str(e) if str(e) else "unable to load libnixl.so"
nixl_prefix = os.environ.get("NIXL_PREFIX") or "/opt/nvidia/nvda_nixl"
prefix_exists = os.path.isdir(nixl_prefix)
# Derive a concise version string to show at the node level.
# Prefer the base "nixl" dist if present; otherwise fall back to any
# discovered nixl* distribution (e.g. nixl-cu12, nixl-cu13, ...).
version = dist_versions.get("nixl") or dist_versions.get("NIXL")
if not version:
for k in sorted(dist_versions.keys()):
version = dist_versions.get(k)
if version:
break
if version:
status = NodeStatus.OK if libnixl_ok else NodeStatus.WARNING
desc = version
elif libnixl_ok or prefix_exists:
# Native bits appear present, but Python package isn't installed.
status = NodeStatus.WARNING
desc = "native library present, Python wheel not installed"
else:
status = NodeStatus.UNKNOWN
desc = "not installed"
super().__init__(label="NIXL", desc=desc, status=status)
# Add a few high-signal details as children.
if dist_versions:
dists = NodeInfo(label="Python distributions", status=NodeStatus.INFO)
for name in sorted(dist_versions.keys()):
dists.add_child(
NodeInfo(
label=name,
desc=dist_versions[name],
status=NodeStatus.INFO,
)
)
self.add_child(dists)
self.add_child(
NodeInfo(
label="libnixl.so",
desc="loadable" if libnixl_ok else (libnixl_err or "not loadable"),
status=NodeStatus.OK if libnixl_ok else NodeStatus.WARNING,
)
)
self.add_child(
NodeInfo(
label="NIXL_PREFIX",
desc=self._replace_home_with_var(nixl_prefix),
status=NodeStatus.OK if prefix_exists else NodeStatus.INFO,
)
)
class PythonInfo(NodeInfo):
"""Python installation information.
In `--runtime-check-only` mode, Python is still useful to report, but failures should not
block the container sanity check, so missing/broken Python is downgraded to WARNING.
"""
def __init__(self, runtime_check: bool = False):
self.runtime_check = runtime_check
py_version = platform.python_version()
py_exec = sys.executable or "python"
display_py_exec = self._replace_home_with_var(py_exec)
if os.path.exists(py_exec):
status = NodeStatus.OK
else:
status = NodeStatus.WARNING if self.runtime_check else NodeStatus.ERROR
super().__init__(
label="Python",
desc=f"{py_version}, {display_py_exec}",
status=status,
)
# Check for PyTorch (optional)
try:
torch = __import__("torch")
version = getattr(torch, "__version__", "installed")
# Check CUDA availability
cuda_status = None
if hasattr(torch, "cuda"):
try:
cuda_available = torch.cuda.is_available()
cuda_status = (
"✅torch.cuda.is_available"
if cuda_available
else "❌torch.cuda.is_available"
)
except Exception:
pass
# Get installation path
install_path = None
if hasattr(torch, "__file__") and torch.__file__:
file_path = torch.__file__
if "site-packages" in file_path:
parts = file_path.split(os.sep)
for i, part in enumerate(parts):
if part == "site-packages":
install_path = os.sep.join(parts[: i + 1])
break
elif file_path:
install_path = os.path.dirname(file_path)
if install_path:
install_path = self._replace_home_with_var(install_path)
package_info = PythonPackageInfo(
package_name="PyTorch",
version=version,
cuda_status=cuda_status,
install_path=install_path,
is_framework=False,
)
self.add_child(package_info)
except ImportError:
pass # PyTorch is optional, don't show if not installed
# Check NIXL (optional, but useful to report when present/missing)
self.add_child(NixlInfo())
# Add PYTHONPATH
pythonpath = os.environ.get("PYTHONPATH", "")
self.add_child(PythonPathInfo(pythonpath))
class FrameworkInfo(NodeInfo):
"""LLM Framework information"""
def __init__(self, no_framework_check: bool = False):
super().__init__(label="🤖Framework", status=NodeStatus.INFO)
if no_framework_check:
# Why: In some environments (CI, minimal runtime containers) we may want to
# validate the Dynamo install without requiring a framework/engine package
# (vllm/sglang/tensorrt_llm) to be present.
self.desc = "skipped (--no-framework-check)"
return
# Check for framework packages (mandatory to show)
frameworks_to_check = [
("vllm", "vLLM"),
("sglang", "Sglang"),
("tensorrt_llm", "tensorRT LLM"),
]
frameworks_found = 0
gpu_dependent_found = 0
for module_name, display_name in frameworks_to_check:
# First check if module exists without importing (for GPU-dependent modules)
import importlib.metadata
import importlib.util
spec = importlib.util.find_spec(module_name)
if not spec:
# Module not installed at all
continue
# Module exists, try to get version from metadata (doesn't require import)
version = None
try:
version = importlib.metadata.version(module_name)
except Exception:
# Try alternative package names
alt_names = {
"tensorrt_llm": "tensorrt-llm",
"sglang": "sglang",
"vllm": "vllm",
}
if module_name in alt_names:
try:
version = importlib.metadata.version(alt_names[module_name])
except Exception:
pass
# Get module path from spec
module_path = None
if spec.origin:
module_path = self._replace_home_with_var(spec.origin)
# Get executable path (special handling for each framework)
exec_path = None
exec_names = {
"vllm": "vllm",
"sglang": "sglang",
"tensorrt_llm": "trtllm-build",
}
if module_name in exec_names:
exec_path_raw = shutil.which(exec_names[module_name])
if exec_path_raw:
exec_path = self._replace_home_with_var(exec_path_raw)
# Now try to import to get runtime version if needed
gpu_required = False
try:
module = __import__(module_name)
# Get version from module if not already found
if not version:
version = getattr(module, "__version__", "installed")
except ImportError as e:
# Check if it's a GPU-related error
error_msg = str(e).lower()
if "libcuda" in error_msg or "cuda" in error_msg:
gpu_required = True
gpu_dependent_found += 1
except Exception:
pass
# If we found the module (either importable or just installed)
if spec:
frameworks_found += 1
if not version:
version = "installed"
# Add status indicator to version for GPU-dependent modules
if gpu_required:
version = f"{version} (requires GPU)"
package_info = PythonPackageInfo(
package_name=display_name,
version=version,
module_path=module_path,
exec_path=exec_path,
is_framework=True,
is_installed=True,
)
self.add_child(package_info)
# If no frameworks found, set status to ERROR (X) and show what's missing
if frameworks_found == 0:
self.status = NodeStatus.ERROR
# List all the frameworks that were checked but not found
missing_frameworks = []
for module_name, display_name in frameworks_to_check:
missing_frameworks.append(f"no {module_name}")
missing_text = ", ".join(missing_frameworks)
self.desc = missing_text
elif gpu_dependent_found > 0:
# At least one framework needs GPU
self.status = NodeStatus.WARNING
class PythonPackageInfo(NodeInfo):
"""Python package information"""
def __init__(
self,
package_name: str,
version: str,
cuda_status: Optional[str] = None,
module_path: Optional[str] = None,
exec_path: Optional[str] = None,
install_path: Optional[str] = None,
is_framework: bool = False,
is_installed: bool = True,
):
# Build display value
display_value = version
# Determine status based on whether package is installed
if not is_installed or version == "-":
# Framework not found - show with "-" and use UNKNOWN status for ❓ symbol
display_value = "-"
status = NodeStatus.UNKNOWN # Show ❓ for not found frameworks
else:
status = NodeStatus.OK
# Add CUDA status for PyTorch
if cuda_status:
display_value = f"{version}, {cuda_status}"
# Don't add install path for PyTorch with CUDA status
# For frameworks, add module and exec paths
elif is_framework and (module_path or exec_path):
parts = [version]
if module_path:
parts.append(f"module={module_path}")
if exec_path:
parts.append(f"exec={exec_path}")
display_value = ", ".join(parts)
# For regular packages, add install path
elif install_path:
display_value = f"{version} ({install_path})"
super().__init__(label=package_name, desc=display_value, status=status)
class PythonPathInfo(NodeInfo):
"""PYTHONPATH environment variable information"""
def __init__(self, pythonpath: str):
if pythonpath:
# Split by colon and replace home in each path
paths = pythonpath.split(":")
display_paths = []
has_invalid_paths = False
for p in paths:
display_path = self._replace_home_with_var(p)
# Check if path exists and is accessible
if not os.path.exists(p) or not os.access(p, os.R_OK):
display_paths.append(
f"{Colors.BRIGHT_RED}{display_path}{Colors.RESET}"
) # Bright red path
has_invalid_paths = True
else:
display_paths.append(display_path)
display_pythonpath = ":".join(display_paths)
status = NodeStatus.WARNING if has_invalid_paths else NodeStatus.INFO
else:
display_pythonpath = "not set"
status = (
NodeStatus.INFO
) # PYTHONPATH not set is fine with editable installs
super().__init__(label="PYTHONPATH", desc=display_pythonpath, status=status)
class DynamoRuntimeInfo(NodeInfo):
"""Dynamo runtime components information"""
def __init__(
self,
workspace_dir: Optional[str],
thorough_check: bool = False,
runtime_check: bool = False,
):
self.thorough_check = thorough_check
self.runtime_check = runtime_check
# Try to get package version
import importlib.metadata
try:
version = importlib.metadata.version("ai-dynamo-runtime")
runtime_value = f"ai-dynamo-runtime {version}"
is_installed = True
except Exception:
runtime_value = "ai-dynamo-runtime - Not installed"
is_installed = False
super().__init__(
label="Runtime components",
desc=runtime_value,
status=NodeStatus.INFO, # Will update based on components found
)
# Add package info if installed
if is_installed:
# Add dist-info directory
dist_info = self._find_dist_info()
if dist_info:
self.add_child(dist_info)
# Add .pth file
pth_file = self._find_pth_file()
if pth_file:
self.add_child(pth_file)
# Check for multiple _core*.so files (only if workspace exists)
if workspace_dir:
multiple_so_warning = self._check_multiple_core_so(workspace_dir)
if multiple_so_warning:
self.add_child(multiple_so_warning)
# Discover runtime components from source
components = self._discover_runtime_components(workspace_dir)
# For runtime check, always try to import the core modules
if self.runtime_check:
# Force check of essential runtime modules
essential_components = ["dynamo._core", "dynamo.runtime"]
for comp in essential_components:
if comp not in components:
components.append(comp)
# Find where each component actually is and add them
if components:
# Calculate max width for alignment
max_len = max(len(comp) for comp in components)
components_found = False
import_failures = []
for component in components:
try:
# Try to import to find actual location
module = __import__(component, fromlist=[""])
module_path = getattr(module, "__file__", None)
if module_path:
# Add timestamp for .so files
timestamp_str = ""
if module_path.endswith(".so"):
try:
stat = os.stat(module_path)
timestamp = self._format_timestamp_pdt(stat.st_mtime)
timestamp_str = f", modified={timestamp}"
except Exception:
pass
display_path = self._replace_home_with_var(module_path)
padded_name = f"{component:<{max_len}}"
module_node = NodeInfo(
label=f"✅ {padded_name}",
desc=f"{display_path}{timestamp_str}",
status=NodeStatus.NONE,
)
self.add_child(module_node)
components_found = True
except ImportError as e:
# Module not importable - show as error
padded_name = f"{component:<{max_len}}"
error_msg = str(e) if str(e) else "Import failed"
module_node = NodeInfo(
label=padded_name, desc=error_msg, status=NodeStatus.ERROR
)
self.add_child(module_node)
import_failures.append(component)
# Don't set components_found to True for failed imports
# Update status and value based on whether we found components
if components_found:
# For runtime check, fail if any essential component failed to import
if self.runtime_check and import_failures:
essential_failed = any(
comp in import_failures
for comp in ["dynamo._core", "dynamo.runtime"]
)
if essential_failed:
self.status = NodeStatus.ERROR
self.desc = "ai-dynamo-runtime - FAILED (essential modules not importable)"
else:
self.status = NodeStatus.OK
else:
self.status = NodeStatus.OK
# If not installed but components work via PYTHONPATH, update the message
if not is_installed and self.status == NodeStatus.OK:
self.desc = "ai-dynamo-runtime (via PYTHONPATH)"
else:
self.status = NodeStatus.ERROR
if self.runtime_check:
self.desc = "ai-dynamo-runtime - FAILED (no components found)"
else:
# No components discovered at all
self.status = NodeStatus.ERROR
# Final check: if no children at all (no components found), ensure it's an error
if not self.children:
self.status = NodeStatus.ERROR
def _check_multiple_core_so(self, workspace_dir: str) -> Optional[NodeInfo]:
"""Check for multiple _core*.so files and return warning if found.
Multiple _core*.so files are problematic because:
- Python's import system picks up the first matching file it finds
- This can lead to loading the wrong/outdated binary module
- Different naming patterns (_core.abi3.so vs _core.cpython-312-x86_64-linux-gnu.so)
indicate different build configurations which shouldn't coexist
- Can cause confusing import errors when the wrong .so is loaded
- Typically occurs when switching between maturin build modes or Python versions
Returns:
NodeInfo with warning if multiple .so files found, None otherwise
"""
if not workspace_dir:
return None
core_dir = os.path.join(workspace_dir, DYNAMO_RUNTIME_SRC_PATH)
if not os.path.exists(core_dir):
return None
try:
# Find all _core*.so files
so_files = glob.glob(os.path.join(core_dir, "_core*.so"))
if len(so_files) > 1:
# Multiple .so files found - create warning
so_file_names = [os.path.basename(f) for f in so_files]
warning_desc = (
f"Found {len(so_files)} files: {', '.join(so_file_names)}. "
f"Python may load the wrong version causing import errors. "
f"You may need to remove old *.so files and/or rebuild via 'maturin develop'."
)
return NodeInfo(
label="Multiple _core*.so files detected",
desc=warning_desc,
status=NodeStatus.WARNING,
)
except Exception:
pass
return None
def _discover_runtime_components(self, workspace_dir: Optional[str]) -> list:
"""Discover ai-dynamo-runtime components from filesystem.
Returns:
List of runtime component module names
Example: ['dynamo._core', 'dynamo.nixl_connect', 'dynamo.llm', 'dynamo.runtime']
Note: Always includes 'dynamo._core' (compiled Rust module), then scans
DYNAMO_RUNTIME_SRC_PATH for additional components.
"""
components = ["dynamo._core"] # Always include compiled Rust module
if not workspace_dir:
return components
# Scan runtime components (llm, runtime, nixl_connect, etc.)
runtime_path = os.path.join(workspace_dir, DYNAMO_RUNTIME_SRC_PATH)
if not os.path.exists(runtime_path):
return components
for item in os.listdir(runtime_path):
item_path = os.path.join(runtime_path, item)
if os.path.isdir(item_path) and os.path.exists(
os.path.join(item_path, "__init__.py")
):
components.append(f"dynamo.{item}")
return components
def _find_dist_info(self) -> Optional[NodeInfo]:
"""Find the dist-info directory for ai-dynamo-runtime."""
import site
for site_dir in site.getsitepackages():
pattern = os.path.join(site_dir, "ai_dynamo_runtime*.dist-info")
matches = glob.glob(pattern)
if matches:
path = matches[0]
display_path = self._replace_home_with_var(path)
try:
stat = os.stat(path)
timestamp = self._format_timestamp_pdt(stat.st_ctime)
return NodeInfo(
label=f" {display_path}",
desc=f"created={timestamp}",
status=NodeStatus.INFO,
metadata={"part_of_previous": True},
)
except Exception:
return NodeInfo(
label=f" {display_path}",
status=NodeStatus.INFO,
metadata={"part_of_previous": True},
)
return None
def _find_pth_file(self) -> Optional[NodeInfo]:
"""Find the .pth file for ai-dynamo-runtime."""
import site
for site_dir in site.getsitepackages():
pth_path = os.path.join(site_dir, "ai_dynamo_runtime.pth")
if os.path.exists(pth_path):
display_path = self._replace_home_with_var(pth_path)
try:
stat = os.stat(pth_path)
timestamp = self._format_timestamp_pdt(stat.st_mtime)
node = NodeInfo(
label=f" {display_path}",
desc=f"modified={timestamp}",
status=NodeStatus.INFO,
metadata={"part_of_previous": True},
)
# Read where it points to
with open(pth_path, "r") as f:
content = f.read().strip()
if content:
display_content = self._replace_home_with_var(content)
points_to = NodeInfo(
label="→", desc=display_content, status=NodeStatus.INFO
)
node.add_child(points_to)
return node
except Exception:
return NodeInfo(label=display_path, status=NodeStatus.INFO)
return None
class DynamoFrameworkInfo(NodeInfo):
"""Dynamo framework components information"""
def __init__(
self,
workspace_dir: Optional[str],
thorough_check: bool = False,
runtime_check: bool = False,
):
self.thorough_check = thorough_check
self.runtime_check = runtime_check
# Try to get package version
import importlib.metadata
try:
version = importlib.metadata.version("ai-dynamo")
framework_value = f"ai-dynamo {version}"
is_installed = True
except Exception:
framework_value = "ai-dynamo - Not installed"
is_installed = False
super().__init__(
label="Framework components",
desc=framework_value,
status=NodeStatus.INFO, # Will update based on components found
)
# Add package info if installed
if is_installed:
import glob
import site
for site_dir in site.getsitepackages():
# Look specifically for ai_dynamo (not ai_dynamo_runtime)
dist_pattern = os.path.join(site_dir, "ai_dynamo-*.dist-info")
matches = glob.glob(dist_pattern)
if matches:
path = matches[0]
display_path = self._replace_home_with_var(path)
try:
stat = os.stat(path)
timestamp = self._format_timestamp_pdt(stat.st_ctime)
dist_node = NodeInfo(
label=f" {display_path}",
desc=f"created={timestamp}",
status=NodeStatus.INFO,
metadata={"part_of_previous": True},
)
self.add_child(dist_node)
except Exception:
dist_node = NodeInfo(
label=f" {display_path}",
status=NodeStatus.INFO,
metadata={"part_of_previous": True},
)
self.add_child(dist_node)
break
# Discover framework components from source
components = self._discover_framework_components(workspace_dir)
# For runtime check, always try to import at least one framework component
if self.runtime_check and not components:
# Try common framework components even if not discovered
components = [
"dynamo.frontend",
"dynamo.vllm",
"dynamo.sglang",
"dynamo.trtllm",
]
# Find where each component actually is and add them
if components:
# Sort components for consistent output
components.sort()
# Calculate max width for alignment
max_len = max(len(comp) for comp in components)
components_found = False
import_failures = []
for component in components:
try:
# Try to import to find actual location
module = __import__(component, fromlist=[""])
module_path = getattr(module, "__file__", None)
if module_path:
display_path = self._replace_home_with_var(module_path)
padded_name = f"{component:<{max_len}}"
component_node = NodeInfo(
label=f"✅ {padded_name}",
desc=display_path,
status=NodeStatus.NONE,
)
self.add_child(component_node)
components_found = True
except ImportError as e:
# Module not importable - show as error
padded_name = f"{component:<{max_len}}"
error_msg = str(e) if str(e) else "Import failed"
component_node = NodeInfo(
label=padded_name, desc=error_msg, status=NodeStatus.ERROR
)
self.add_child(component_node)
import_failures.append(component)
# Don't set components_found to True for failed imports
# Update status and value based on whether we found components
if components_found:
# For runtime check, we need at least one component to work
if self.runtime_check and len(import_failures) == len(components):
self.status = NodeStatus.ERROR
self.desc = "ai-dynamo - FAILED (no components importable)"
else:
self.status = NodeStatus.OK
# If not installed but components work via PYTHONPATH, update the message
if not is_installed and self.status == NodeStatus.OK:
self.desc = "ai-dynamo (via PYTHONPATH)"
else:
self.status = NodeStatus.ERROR
if self.runtime_check:
self.desc = "ai-dynamo - FAILED (no components found)"
else:
# No components discovered at all
self.status = NodeStatus.ERROR
def _discover_framework_components(self, workspace_dir: Optional[str]) -> list:
"""Discover ai-dynamo framework components from filesystem.
Returns:
List of framework component module names
Example: ['dynamo.frontend', 'dynamo.planner', 'dynamo.vllm', 'dynamo.sglang']
Note: Scans components/src/dynamo/... directory for modules with __init__.py files.
"""
components: List[str] = []
if not workspace_dir:
return components
# Scan the components/src/dynamo/... Python directory for __init__.py files
components_path = os.path.join(workspace_dir, "components", "src", "dynamo")
if os.path.exists(components_path):
for item in os.listdir(components_path):
item_path = os.path.join(components_path, item)
if os.path.isdir(item_path):
# Check for dynamo module in src
module_path = os.path.join(item_path, "__init__.py")
if os.path.exists(module_path):
components.append(f"dynamo.{item}")
return components
class DynamoInfo(NodeInfo):
"""Dynamo workspace information"""
def __init__(self, thorough_check: bool = False, runtime_check: bool = False):
self.thorough_check = thorough_check
self.runtime_check = runtime_check
# Find workspace directory
workspace_dir = DynamoInfo.find_workspace()
# For runtime check, we don't need a workspace - just check packages
if self.runtime_check and not workspace_dir:
super().__init__(
label="Dynamo",
desc="workspace not found (runtime container) - checking installed packages",
status=NodeStatus.WARNING,
)
# Check runtime components even without workspace
runtime_info = DynamoRuntimeInfo(
None,
thorough_check=self.thorough_check,
runtime_check=self.runtime_check,
)
self.add_child(runtime_info)
# Check framework components even without workspace
framework_info = DynamoFrameworkInfo(
None,
thorough_check=self.thorough_check,
runtime_check=self.runtime_check,
)
self.add_child(framework_info)
return
if not workspace_dir:
# Show error when workspace is not found
super().__init__(
label="Dynamo",
desc="workspace not found - cannot detect Runtime and Framework components",
status=NodeStatus.ERROR,
)
# Add helpful information about where we looked
search_paths = NodeInfo(
label="Searched in",
desc="current dir, ~/dynamo, DYNAMO_HOME, /workspace",
status=NodeStatus.INFO,
)
self.add_child(search_paths)
hint = NodeInfo(
label="Hint",
desc="Run from a Dynamo workspace directory or set DYNAMO_HOME",
status=NodeStatus.INFO,
)
self.add_child(hint)
return
# Build main label
display_workspace = self._replace_home_with_var(workspace_dir)
super().__init__(label="Dynamo", desc=display_workspace, status=NodeStatus.INFO)
# Add explicit git info as a child so it's always visible and can clearly say
# "not a git directory" when unavailable.
git_sha, git_date, git_branch, git_msg = self._get_git_info(workspace_dir)
if git_sha:
parts = [git_sha]
if git_branch:
parts.append(f"branch={git_branch}")
if git_date:
parts.append(f"Date: {git_date}")
git_desc = ", ".join(parts)
else:
git_desc = git_msg
self.add_child(
NodeInfo(label="Git HEAD", desc=git_desc, status=NodeStatus.INFO)
)
# Always add runtime components
runtime_info = DynamoRuntimeInfo(
workspace_dir,
thorough_check=self.thorough_check,
runtime_check=self.runtime_check,
)
self.add_child(runtime_info)
# Always add framework components
framework_info = DynamoFrameworkInfo(
workspace_dir,
thorough_check=self.thorough_check,
runtime_check=self.runtime_check,
)
self.add_child(framework_info)
def _get_git_info(
self, workspace_dir: str
) -> Tuple[Optional[str], Optional[str], Optional[str], str]:
"""Get git SHA, date, and branch for the workspace (or a clear message when unavailable)."""
git_bin = shutil.which("git")
if not git_bin:
return None, None, None, "git not found"
try:
# First, detect whether we're inside a git work tree.
result = subprocess.run(
[git_bin, "rev-parse", "--is-inside-work-tree"],
capture_output=True,
text=True,
cwd=workspace_dir,
timeout=5,
)
if result.returncode != 0 or result.stdout.strip().lower() != "true":
return None, None, None, "not in a git directory"
# Get short SHA
result = subprocess.run(
[git_bin, "rev-parse", "--short", "HEAD"],
capture_output=True,
text=True,
cwd=workspace_dir,
timeout=5,
)
sha = result.stdout.strip() if result.returncode == 0 else None
# Get branch name (best-effort). In detached HEAD this returns "HEAD".
branch: Optional[str] = None
try:
result = subprocess.run(
[git_bin, "rev-parse", "--abbrev-ref", "HEAD"],
capture_output=True,
text=True,
cwd=workspace_dir,
timeout=5,
)
if result.returncode == 0:
candidate = result.stdout.strip()
if candidate and candidate != "HEAD":
branch = candidate
elif candidate == "HEAD":
branch = "detached"
except Exception:
branch = None
# Get commit date
result = subprocess.run(
[git_bin, "show", "-s", "--format=%ci", "HEAD"],
capture_output=True,
text=True,
cwd=workspace_dir,
timeout=5,
)
if result.returncode == 0 and result.stdout.strip():
# Convert to PDT format
date_str = result.stdout.strip()
# Parse and format as PDT
try:
# Parse the git date (format: 2025-08-30 23:22:29 +0000)
import datetime as dt_module
# Split off timezone info
date_part = date_str.rsplit(" ", 1)[0]
dt = dt_module.datetime.strptime(date_part, "%Y-%m-%d %H:%M:%S")
# Convert to PDT (UTC-7)
dt_pdt = dt - dt_module.timedelta(hours=7)
date = dt_pdt.strftime("%Y-%m-%d %H:%M:%S PDT")
except Exception:
date = date_str
else:
date = None
if sha:
return sha, date, branch, ""
return None, None, None, "not in a git directory"
except Exception:
return None, None, None, "not in a git directory"
@staticmethod
def find_workspace() -> Optional[str]:
"""Find dynamo workspace directory."""
candidates = []
# Check DYNAMO_HOME environment variable first
dynamo_home = os.environ.get("DYNAMO_HOME")
if dynamo_home:
candidates.append(os.path.expanduser(dynamo_home))
# Then check common locations
candidates.extend(
[
".", # Current directory
os.path.expanduser("~/dynamo"),
"/workspace",
]
)
for candidate in candidates:
if DynamoInfo.is_dynamo_workspace(candidate):
return os.path.abspath(candidate)
return None
@staticmethod
def is_dynamo_workspace(path: str) -> bool:
"""Check if directory is a dynamo workspace."""
if not os.path.exists(path):
return False
# Check for indicators of a dynamo workspace
indicators = [
"README.md",
"components",
"lib/bindings/python",
"lib/runtime",
"Cargo.toml",
]
# Require at least 3 indicators to be confident
found = 0
for indicator in indicators:
check_path = os.path.join(path, indicator)
if os.path.exists(check_path):
found += 1
return found >= 3
def has_framework_errors(tree: NodeInfo) -> bool:
"""Check if there are framework component errors in the tree"""
# Find the Dynamo node
for child in tree.children:
if child.label and "Dynamo" in child.label:
# Find the Framework components node
for dynamo_child in child.children:
if dynamo_child.label and "Framework components" in dynamo_child.label:
# Use the has_errors() method to check the entire subtree
return dynamo_child.has_errors()
return False
def show_installation_recommendation():
"""Show installation recommendations for missing components."""
print("\nTo install missing components for development (not production):")
print(" Runtime: (cd lib/bindings/python && maturin develop)")
print(" Framework: uv pip install -e .")
print(" or export PYTHONPATH=$DYNAMO_HOME/components/src\n")
def get_installation_recommendation_lines() -> List[str]:
"""
Get installation recommendations for missing components.
Why: `--json-output` must keep stdout JSON-only. We return structured lines that
can be embedded in JSON instead of printing free-form text.
"""
return [
"To install missing components for development (not production):",
" Runtime: (cd lib/bindings/python && maturin develop)",
" Framework: uv pip install -e .",
" or export PYTHONPATH=$DYNAMO_HOME/components/src",
]
def main():
"""Main function - collect and display system information"""
import argparse
import sys
# Parse command line arguments
parser = argparse.ArgumentParser(
description="Display system information for Dynamo project"
)
parser.add_argument(
"--thorough-check",
action="store_true",
help="Enable thorough checking (file permissions, directory sizes, disk space, CUDA/NVIDIA info, etc.)",
)
parser.add_argument(
"--terse",
action="store_true",
help="Show only essential information (OS, User, GPU, Framework, Dynamo) and errors",
)
parser.add_argument(
"--json",
"--json-output",
dest="json_output",
action="store_true",
help="Output a JSON representation (terse subset) suitable for copy/paste",
)
parser.add_argument(
"--runtime-check-only",
"--runtime-check",
"--runtime",
dest="runtime_check",
action="store_true",
help="Skip compile-time dependency checks (Rust, Cargo, Maturin) for runtime containers and validate ai-dynamo packages",
)
parser.add_argument(
"--no-gpu-check",
action="store_true",
help="Skip GPU detection and information collection (useful for CI environments without GPU access)",
)
parser.add_argument(
"--no-framework-check",
dest="no_framework_check",
action="store_true",
help="Skip LLM framework package checks (vllm, sglang, tensorrt_llm)",
)
args = parser.parse_args()
# Validate mutual exclusion
if args.thorough_check and args.terse:
parser.error("--thorough-check and --terse cannot be used together")
if args.json_output and args.thorough_check:
parser.error("--json-output and --thorough-check cannot be used together")
if args.json_output and args.terse:
parser.error(
"--json-output and --terse cannot be used together (json-output is already terse)"
)
# Keep `--json-output` output JSON-only for copy/paste (no Python warnings noise).
if args.json_output:
import warnings
warnings.filterwarnings("ignore")
# Simply create a SystemInfo instance - it collects everything in its constructor
tree = SystemInfo(
thorough_check=args.thorough_check,
terse=args.terse or args.json_output,
runtime_check=args.runtime_check,
no_gpu_check=args.no_gpu_check,
no_framework_check=args.no_framework_check,
)
framework_errors = has_framework_errors(tree)
if args.json_output:
out = tree.to_json_obj()
if framework_errors:
out["install_recommendation"] = get_installation_recommendation_lines()
print(
json.dumps(out, separators=(",", ":"), sort_keys=True, ensure_ascii=False)
)
else:
tree.print_tree()
# Check if there are framework component errors and show installation recommendation
if framework_errors and not args.json_output:
show_installation_recommendation()
# Exit with non-zero status if there are any errors
if tree.has_errors():
sys.exit(1)
else:
sys.exit(0)
if __name__ == "__main__":
main()
Reference in New Issue View Git Blame Copy Permalink