Files
project_6/upstream_ref/xllm/scripts/build_support/utils.py
EX Engine 002f9879b2 ref(upstream): FULL TREE — Deep-Spark xllm (1470) + ds_vllm csrc/models (703)
Replaces cherry-picked upstream_ref with complete source trees.

xllm/ — Iluvatar official C++ inference engine (15MB, 1470 files)
  Complete: kernels → layers → models → runtime → scheduler → api
  Excluded: .git, binary images, third_party submodule checkouts

ds_vllm/ — Iluvatar official vllm fork (8MB, 703 files)
  Included: csrc/ (ALL CUDA kernels), fused_moe/, qwen3_5 model, _custom_ops
  Excluded: tests, benchmarks, docs, examples (not needed for reference)

Critical call chains now fully traceable:
  MoE: moe_topk_softmax_kernels.cuh → ixformer.h → fused_moe.cpp → layer
  GDN: qwen3_gated_delta_net_base.cpp → qwen3_5_gated_delta_net.cpp
  Attention: ixformer.h → xllm_paged_attention → attention.cpp
2026-08-10 02:54:03 +00:00

390 lines
12 KiB
Python
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import os
import sys
import platform
import subprocess
import sysconfig
import io
import shlex
from pathlib import Path
from typing import Optional
# get cpu architecture
def get_cpu_arch() -> str:
arch = platform.machine()
if "x86" in arch or "amd64" in arch:
return "x86"
elif "arm" in arch or "aarch64" in arch:
return "arm"
else:
raise ValueError(f"❌ Unsupported architecture: {arch}")
# get device type
def get_device_type() -> str:
import torch
if torch.cuda.is_available():
try:
import ixformer
return "ilu"
except ImportError:
return "cuda"
try:
import torch_musa
if torch.musa.is_available():
return "musa"
except ImportError:
pass
try:
import torch_mlu
if torch.mlu.is_available():
return "mlu"
except ImportError:
pass
try:
import torch_npu
if torch.npu.is_available():
return "npu"
except ImportError:
pass
print("❌ Unsupported device type, please check what device you are using.")
exit(1)
def get_base_dir() -> str:
helper_path = Path(__file__).resolve()
for parent in helper_path.parents:
if all((parent / marker).exists() for marker in ("setup.py", "version.txt", "CMakeLists.txt")):
return str(parent)
fallback_index = min(2, len(helper_path.parents) - 1)
return str(helper_path.parents[fallback_index])
def _join_path(*paths: str) -> str:
return os.path.join(get_base_dir(), *paths)
# return the python version as a string like "310" or "311" etc
def get_python_version() -> str:
return sysconfig.get_python_version().replace(".", "")
def get_torch_version(device: str) -> Optional[str]:
try:
import torch
if device == "cuda":
return torch.__version__
return torch.__version__.split('+')[0]
except ImportError:
return None
def get_version() -> str:
# first read from environment variable
version: Optional[str] = os.getenv("XLLM_VERSION")
if not version:
# then read from version file
with open(_join_path("version.txt"), "r") as f:
version = f.read().strip()
# strip the leading 'v' if present
if version and version.startswith("v"):
version = version[1:]
if not version:
raise RuntimeError("❌ Unable to find version string.")
version_suffix = os.getenv("XLLM_VERSION_SUFFIX")
if version_suffix:
version += version_suffix
return version
def read_readme() -> str:
p = _join_path("README.md")
if os.path.isfile(p):
return io.open(p, "r", encoding="utf-8").read()
else:
return ""
def get_cmake_dir() -> str:
plat_name = sysconfig.get_platform()
python_version = get_python_version()
dir_name = f"cmake.{plat_name}-{sys.implementation.name}-{python_version}"
cmake_dir = os.path.join(get_base_dir(), "build", dir_name)
os.makedirs(cmake_dir, exist_ok=True)
return cmake_dir
def check_and_install_pre_commit() -> None:
# check if .git is a directory
if not os.path.isdir(".git"):
return
if not os.path.exists(".git/hooks/pre-commit"):
ok, _, _ = _run_command(["pre-commit", "install"], check=True)
if not ok:
print("❌ Run 'pre-commit install' failed. Please install pre-commit: pip install pre-commit")
exit(1)
def _run_command(
args: list[str],
cwd: Optional[str] = None,
check: bool = True,
input_text: Optional[str] = None,
passthrough_output: bool = False,
) -> tuple[bool, str, str]:
try:
if passthrough_output:
result = subprocess.run(
args,
cwd=cwd,
check=False,
input=input_text,
text=True,
)
else:
result = subprocess.run(
args,
cwd=cwd,
check=False,
input=input_text,
capture_output=True,
text=True,
)
except OSError as e:
return False, "", str(e)
if passthrough_output:
if check and result.returncode != 0:
return False, "", f"exit code {result.returncode}"
return result.returncode == 0, "", ""
if check and result.returncode != 0:
return False, result.stdout.strip(), (result.stderr or result.stdout).strip()
return result.returncode == 0, result.stdout.strip(), (result.stderr or "").strip()
def _print_manual_check_commands(commands: list[str]) -> None:
print("🔎 You can run these commands to inspect manually:")
for cmd in commands:
print(f" {cmd}")
def _run_shell_command(
command: str,
cwd: Optional[str] = None,
check: bool = True,
passthrough_output: bool = False,
) -> bool:
ok, _, err = _run_command(
shlex.split(command),
cwd=cwd,
check=check,
passthrough_output=passthrough_output,
)
if not ok:
print(f"❌ Run shell command '{command}' failed: {err}")
return False
return True
def _run_git_command(repo_root: str, args: list[str]) -> tuple[bool, str]:
ok, output, err = _run_command(["git"] + args, cwd=repo_root, check=True)
if not ok and "No such file or directory" in err:
print(f"❌ Failed to run git command in {repo_root}: git {' '.join(args)}")
print(f" {err}")
return False, ""
if not ok:
print(f"❌ Git command failed in {repo_root}: git {' '.join(args)}")
if err:
print(f" {err}")
return False, ""
return True, output
def _collect_submodule_init_issues(repo_root: str) -> dict[str, str]:
ok, output = _run_git_command(repo_root, ["submodule", "status"])
if not ok:
print("❌ Failed to inspect submodule status.")
_print_manual_check_commands([
f"cd {repo_root}",
"git submodule status",
"git submodule update --init --recursive",
])
exit(1)
issues: dict[str, str] = {}
for line in output.splitlines():
if not line:
continue
state = line[0]
content = line[1:].strip()
parts = content.split()
if len(parts) < 2:
continue
path = parts[1]
commit = parts[0]
if state == "-":
issues[path] = f"uninitialized (expected commit starts with {commit})"
elif state == "+":
issues[path] = f"commit mismatch (checked-out commit starts with {commit})"
elif state == "U":
issues[path] = "merge conflict"
return issues
def _is_dependency_installed(required_files: list[str]) -> bool:
normalized_files = [
os.path.abspath(os.path.expanduser(file_path))
for file_path in required_files
]
return all(os.path.isfile(file_path) for file_path in normalized_files)
def _get_required_dependency_files() -> dict[str, list[str]]:
install_prefix = "/usr/local/yalantinglibs"
return {
"yalantinglibs": [
os.path.join(
install_prefix,
"lib",
"cmake",
"yalantinglibs",
"config.cmake",
),
],
}
def _collect_missing_dependencies(
dependency_files: dict[str, list[str]],
) -> dict[str, list[str]]:
missing: dict[str, list[str]] = {}
for name, required_files in dependency_files.items():
normalized_files = [
os.path.abspath(os.path.expanduser(file_path))
for file_path in required_files
]
if not _is_dependency_installed(normalized_files):
missing[name] = normalized_files
return missing
def _export_cmake_prefix_paths(prefix_paths: list[str]) -> None:
existing = os.environ.get("CMAKE_PREFIX_PATH", "")
merged_paths: list[str] = []
for path in existing.split(os.pathsep):
if not path:
continue
normalized_path = os.path.abspath(os.path.expanduser(path))
if normalized_path and normalized_path not in merged_paths:
merged_paths.append(normalized_path)
for path in prefix_paths:
if not path:
continue
normalized_path = os.path.abspath(os.path.expanduser(path))
if normalized_path and normalized_path not in merged_paths:
merged_paths.append(normalized_path)
if not merged_paths:
return
os.environ["CMAKE_PREFIX_PATH"] = os.pathsep.join(merged_paths)
print(f"✅ Export CMAKE_PREFIX_PATH to environment: {os.environ['CMAKE_PREFIX_PATH']}")
def _run_dependencies_script_or_exit(script_path: str) -> None:
if not _run_shell_command(
"sh third_party/dependencies.sh",
cwd=script_path,
passthrough_output=True,
):
print("❌ Run shell command 'sh third_party/dependencies.sh' failed!")
_print_manual_check_commands([
f"cd {script_path}",
"sh third_party/dependencies.sh",
])
exit(1)
def _validate_submodules_or_exit(repo_root: str) -> None:
issues = _collect_submodule_init_issues(repo_root)
if issues:
print("❌ Submodule commit check failed. Repositories not correctly initialized:")
for path in sorted(issues):
print(f" - {path}: {issues[path]}")
print("\nPlease align submodules and try again:")
print(" git submodule update --init --recursive [-f|--force]")
exit(1)
def _ensure_prebuild_dependencies_installed(script_path: str) -> None:
dependency_files = _get_required_dependency_files()
missing_dependencies = _collect_missing_dependencies(dependency_files)
if missing_dependencies:
missing_names = ", ".join(sorted(missing_dependencies))
print(f" Missing third-party dependencies: {missing_names}. Running dependencies.sh ...")
_run_dependencies_script_or_exit(script_path)
missing_dependencies = _collect_missing_dependencies(dependency_files)
if missing_dependencies:
print("❌ Some third-party dependencies are still missing after running dependencies.sh:")
manual_commands = [f"cd {script_path}", "sh third_party/dependencies.sh"]
for name in sorted(missing_dependencies):
print(f" - {name}")
for file_path in missing_dependencies[name]:
print(f" missing file: {file_path}")
manual_commands.append(f"test -f {file_path}")
_print_manual_check_commands(manual_commands)
exit(1)
_export_cmake_prefix_paths(["/usr/local/yalantinglibs"])
def _get_cmake_cache_path() -> str:
plat_name = sysconfig.get_platform()
dir_name = f"cmake.{plat_name}-{sys.implementation.name}-{get_python_version()}"
return os.path.join(get_base_dir(), "build", dir_name, "CMakeCache.txt")
def _get_xllm_ops_marker_path() -> str:
ascend_home = os.getenv("ASCEND_HOME_PATH", "/usr/local/Ascend/ascend-toolkit/latest")
opp_root = os.path.join(ascend_home, "opp")
return os.path.join(opp_root, "vendors", "xllm", ".xllm_ops_git_head")
def _clear_xllm_ops_cache_git_head(cache_path: str) -> bool:
if not os.path.isfile(cache_path):
return False
cache_prefix = "XLLM_OPS_GIT_HEAD_CACHED:"
with open(cache_path, "r", encoding="utf-8") as cache_file:
old_lines = cache_file.readlines()
new_lines = [line for line in old_lines if not line.startswith(cache_prefix)]
if new_lines == old_lines:
return False
temp_file_path = f"{cache_path}.tmp"
with open(temp_file_path, "w", encoding="utf-8") as cache_file:
cache_file.writelines(new_lines)
os.replace(temp_file_path, cache_path)
return True
def _ensure_xllm_ops_rebuild_on_missing_marker() -> None:
marker_path = _get_xllm_ops_marker_path()
if os.path.isfile(marker_path):
return
cmake_cache_path = _get_cmake_cache_path()
if _clear_xllm_ops_cache_git_head(cmake_cache_path):
print("✅ Cleared XLLM_OPS_GIT_HEAD_CACHED from CMake cache to trigger xllm_ops rebuild.")
return
def pre_build() -> None:
script_path = get_base_dir()
_validate_submodules_or_exit(script_path)
_ensure_prebuild_dependencies_installed(script_path)
_ensure_xllm_ops_rebuild_on_missing_marker()