TheRock/build_tools/hack/env_check/check_tools.py

# Copyright Advanced Micro Devices, Inc.
# SPDX-License-Identifier: MIT

from __future__ import annotations
from typing import Literal
import os
import re
from pathlib import Path
from abc import ABC
from .utils import cstring, Emoji
from .find_tools import *
from .device import SystemInfo


def msg_stat(status: Literal["pass", "warn", "err"], program: str, message: str):
    if isinstance(program, FindProgram):
        match status:
            case "pass":
                _emoji = Emoji.Pass
            case "warn":
                _emoji = Emoji.Warn
            case "err":
                _emoji = Emoji.Err

        return f"        [{_emoji}][{program}] {message}"

    elif isinstance(program, str):
        match status:
            case "pass":
                _emoji = Emoji.Pass
            case "warn":
                _emoji = Emoji.Warn
            case "err":
                _emoji = Emoji.Err

        return f"        [{_emoji}][{cstring(program, status)}] {message}"


class Check_List:
    def __init__(self, checks: list):
        self.todo = checks
        self.passed, self.warned, self.errs = 0, 0, 0
        self.check_record = []

    def run(self):
        for each_test in self.todo:
            _stat, _except, _result = each_test.__call__()
            print(f"{_stat} {_except}")
            self.check_record.append(_result)

    @property
    def summary(self):
        self.run()
        self.pass_num = cstring(self.check_record.count(True), color="pass")
        self.warn_num = cstring(self.check_record.count(False), color="warn")
        self.err_num = cstring(self.check_record.count(None), color="err")

        return f"""Compoments check {self.pass_num} Passed, {self.warn_num} Warning, {self.err_num} Fatal Error"""


# Program Checkers.


class CheckProgram(ABC):
    def __init__(self, required: bool = True):
        super().__init__()
        self.program = FindProgram()
        self.condition = required
        self.name = "Name"

    def __call__(self):
        return self.check()

    def check(self):
        program = self.program
        name = self.name
        required = self.condition

        if program.exe is None and required:
            _stat = msg_stat("err", name, f"Cannot Find {name}.")
            _except = cstring(
                f"""
            Program {self.name} not found. Please Install it.""",
                "err",
            )
            _result = None
        elif program.exe is None and not required:
            _stat = msg_stat("warn", name, f"Cannot Find {name}.")
            _except = cstring(
                f"""
            Optional {name} not found.""",
                "warn",
            )
            _result = ...
        elif program.exe:
            _stat = msg_stat(
                "pass", name, f"Found {name} {program.version} at {program.exe}"
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckPython(CheckProgram):
    def __init__(self, is_global_env_ok=False):
        super().__init__()
        self.python = FindPython()
        self.name = "Python 3"
        self.is_global_env_ok = is_global_env_ok

    def check(self):
        python = self.python
        name = self.name
        if python.MAJOR_VERSION == 2:
            # This only could happens on Windows.
            _stat = msg_stat("err", name, f"Found Python 2: {python.exe}")
            _except = cstring(
                f"""
    Found Python is Python 2.
    TheRock not support Python 2. Please Switch to Python 3.9+ versions.

        traceback: Unsupported Python versions
            > expected version: 3.9.X ≤ python ≤ 3.13.X, found {python.version}
    """,
                "err",
            )
            _result = None

        elif python.MINOR_VERSION <= 8:
            _stat = msg_stat(
                "err",
                name,
                f"Found Python {python.version} at {python.exe} {python.ENV_TYPE}.",
            )
            _except = cstring(
                f"""
    Found Python version: {python.version}
    TheRock not support Python 3.8 and older versions. Please Switch to Python 3.9+ versions.

        traceback: Unsupported Python versions
            > expected version: 3.9.X ≤ python ≤ 3.13.X, found {python.version}
    """,
                "err",
            )
            _result = None

        elif python.Free_Threaded == True:
            _stat = msg_stat(
                "err", name, f"Found Python {python.exe} is No-GIL version."
            )
            _except = cstring(
                f"""
    TheRock have not support Free-Threaded Python yet.

        traceback: Found Python 3 using Free-Threaded (No-GIL) version
    """,
                "err",
            )
            _result = None

        elif python.interpreter != "cpython":
            _stat = msg_stat(
                "err",
                name,
                f"Found Python {python.exe} interpreter is {python.interpreter}.",
            )
            _except = cstring(
                f"""
    TheRock only supports CPython interpreter.

        traceback: Found Python 3 unexpected interpreter type {python.interpreter}
    """,
                "err",
            )
            _result = None

        elif python.MINOR_VERSION >= 14:
            _stat = msg_stat(
                "warn",
                name,
                f"Found Python {python.version} at {python.exe} {python.ENV_TYPE}.",
            )
            _except = cstring(
                f"""
    Found Python version: {python.version}
    Warning: These newer Python versions are not yet tested.

        traceback: Python 3 version too new may unstable
            > expected version: 3.9.X ≤ python ≤ 3.13.X, found {python.version}
    """,
                "warn",
            )
            _result = False

        elif python.ENV_TYPE == "Global ENV" and not self.is_global_env_ok:
            _stat = msg_stat(
                "warn",
                name,
                f"Found Python {python.version} at {python.exe} {python.ENV_TYPE}.",
            )
            _except = cstring(
                f"""
    Found Python is Global ENV ({python.exe}).
    We recommends you using venv create a clear Python environment to build TheRock.
    Parts of TheRock installed Python dependices may pollute your Global ENV.

        traceback: Detected Global ENV Python3 environment
            > expected Python3 is Virtual ENV, found Global ENV: {python.exe}
    """,
                "warn",
            )
            _result = False

        elif python.ENV_TYPE == "Conda ENV":
            _stat = msg_stat(
                "pass",
                name,
                f"Found Python {python.version} at {python.exe} ({python.ENV_TYPE}).",
            )
            _except = cstring(
                f"""
    Note: Found Conda ENV.
    """,
                "hint",
            )
            _result = True

        else:
            _stat = msg_stat(
                "pass",
                name,
                f"Found Python {python.version} at {python.exe} ({python.ENV_TYPE}).",
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckGit(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindGit()
        self.name = "Git"


class CheckUV(CheckProgram):
    def __init__(self, required=False):
        super().__init__(required)
        self.program = FindUV()
        self.name = "Astral UV"


class CheckCMake(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindCMake()
        self.name = "CMake"

    def check(self):
        if self.program.exe is None:
            _stat = msg_stat("err", "CMake", f"Cannot find CMake.")
            _except = cstring(
                f"""
    No CMake program found. Please check CMake program is installed and in PATH.
    TheRock is a CMake super project requires CMake program.
    For Windows users, please install CMake for Windows support via Visual Studio Installer.
    For Linux users please install it via package manager.
        sh $ apt/dnf install cmake
        sh $ pacman -S cmake

    You can find ROCm/TheRock latest required CMake here:
        https://github.com/ROCm/TheRock/blob/main/docs/environment_setup_guide.md#common-issues

        traceback: Required CMake program not installed or in PATH
    """,
                "err",
            )
            _result = None
        elif (self.program.MAJOR_VERSION, self.program.MINOR_VERSION) < (3, 25):
            _stat = msg_stat(
                "err",
                "CMake",
                f"Found CMake version {self.program.version} at {self.program.exe}",
            )
            _except = cstring(
                f"""
    TheRock requires CMake version >= 3.25, but found {self.program.version}.
    You can find ROCm/TheRock latest required CMake here:
        https://github.com/ROCm/TheRock/blob/main/docs/environment_setup_guide.md#common-issues

        traceback: CMake program too old excluded by TheRock Top-Level CMakeLists.txt rules `cmake_minimum_required()`
            expected: 3.25.X ≤ cmake ≤ 3.31.X, found {self.program.version}
    """,
                "warn",
            )
            _result = None

        else:
            _stat = msg_stat(
                "pass",
                "CMake",
                f"Found CMake {self.program.version} at {self.program.exe}",
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckCCache(CheckProgram):
    def __init__(self, required=False):
        super().__init__(required)
        self.program = FindCCache()
        self.name = "CCache"


class CheckNinja(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindNinja()
        self.name = "Ninja-Build"


# =====  GCC Toolchain  =====


class CheckGCC(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindGCC()
        self.name = "GCC/gcc"

    def check(self):
        gcc = self.program
        if gcc.exe is None:
            _stat = msg_stat("err", self.name, f"GCC compiler program gcc not found.")
            _except = cstring(
                f"""
    TheRock needs installed GCC program {self.name}.

        traceback: Missing GCC compiler program gcc""",
                "err",
            )
            _result = None
        elif gcc.target == "x64":
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found GCC compiler program gcc {gcc.version} at {gcc.exe}",
            )
            _except = ""
            _result = True
        elif gcc.target == "MinGW-x64":
            _stat = msg_stat(
                "err",
                self.name,
                f"Found GCC compiler program gcc {gcc.version} targeting Windows x64.",
            )
            _except = cstring(
                f"""
    TheRock not support using MinGW cross compiling from x86-64 Linux to x64 Windows.
    For Windows builds, please build in Windows OS with Visual Studio environment.
    You can find Windows build instructions here:
        https://github.com/ROCm/TheRock/blob/main/docs/development/windows_support.md

        traceback: Invalid crossing build target {gcc.target}""",
                "err",
            )
            _result = None
        elif gcc.target != "x64":
            _stat = msg_stat(
                "err",
                self.name,
                f"Found GCC compiler program {gcc.version} targeting {gcc.target}.",
            )
            _except = cstring(
                f"""
    TheRock not support cross compiling to target {gcc.target}.

        traceback: Invalid crossing build target {gcc.target}""",
                "err",
            )
            _result = None
        return _stat, _except, _result


class CheckGXX(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindGXX()
        self.name = "GCC/g++"

    def check(self):
        gxx = self.program
        if gxx.exe is None:
            _stat = msg_stat("err", self.name, f"GCC compiler program g++ not found.")
            _except = cstring(
                f"""
    TheRock needs installed GCC program {self.name}.

        traceback: Missing GCC compiler program {self.name}""",
                "err",
            )
            _result = None
        elif gxx.target == "x64":
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found GCC compiler program g++ {gxx.version} at {gxx.exe}",
            )
            _except = ""
            _result = True
        elif gxx.target == "MinGW-x64":
            _stat = msg_stat(
                "err",
                self.name,
                f"Found GCC compiler program g++ {gxx.version} targeting Windows x64.",
            )
            _except = cstring(
                f"""
    TheRock not support using MinGW cross compiling from x86-64 Linux to x64 Windows.
    For Windows builds, please build in Windows OS with Visual Studio environment.
    You can find Windows build instructions here:
        https://github.com/ROCm/TheRock/blob/main/docs/development/windows_support.md

        traceback: Invalid crossing build target {gxx.target}""",
                "err",
            )
            _result = None
        elif gxx.target != "x64":
            _stat = msg_stat(
                "err",
                self.name,
                f"Found GCC compiler program g++ g++ {gxx.version} targeting {gxx.target}.",
            )
            _except = cstring(
                f"""
    TheRock not support cross compiling to target {gxx.target}.

        traceback: Invalid crossing build target {gxx.target}""",
                "err",
            )
            _result = None
        return _stat, _except, _result


class CheckGFortran(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindGFortran()
        self.name = "GCC/gfortran"

    def check(self):
        device = SystemInfo()
        gfort = self.program
        if gfort.exe is None:
            _stat = msg_stat(
                "err", self.name, f"GCC compiler program gfortran not found."
            )
            _except = cstring(
                f"""
    TheRock needs gfortran compiler.

        traceback: Missing GCC compiler program gfortran.""",
                "err",
            )
            _result = None
        elif gfort.target == "x64":
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found GCC compiler program gfortran {gfort.version} at {gfort.exe}",
            )
            _except = ""
            _result = True
        elif gfort.target == "MinGW-x64" and device.is_windows:
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found GCC compiler program gfortran {gfort.version} at {gfort.exe}",
            )
            _except = ""
            _result = True
        elif gfort.target != "x64":
            _stat = msg_stat(
                "err",
                self.name,
                f"Found GCC compiler program gfortran {gfort.version} targeting {gfort.target}.",
            )
            _except = cstring(
                f"""
    TheRock not support cross compiling to target {gfort.target}.

        traceback: Invalid crossing build target {gfort.target}""",
                "err",
            )
            _result = None
        return _stat, _except, _result


class CheckGCC_AR(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindGCC_AR()
        self.name = "Binutils/Archiver"

    def check(self):
        device = SystemInfo()
        ar = self.program
        if ar.exe is None:
            _stat = msg_stat("err", self.name, f"GNU/Binutils Archiver not found.")
            _except = cstring(
                f"""
    TheRock needs GNU/Binutils archiver.

        traceback: Missing GNU/Binutils Archiver program ar.""",
                "err",
            )
            _result = None

        elif ar.exe and device.is_windows:
            _stat = msg_stat(
                "pass", self.name, f"Found GNU/Binutils Archiver is MinGW."
            )
            _except = cstring(
                f"""
    TheRock not support using MinGW compiler toolchain on Windows.
    For Windows builds, please build in Windows OS with Visual Studio environment.
    You can find Windows build instructions here:
        https://github.com/ROCm/TheRock/blob/main/docs/development/windows_support.md

        traceback: Invalid GNU/Binutils Archiver""",
                "err",
            )
            _result = True
        elif ar.exe:
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found GNU/Binutils Archiver {ar.version} at {ar.exe}",
            )
            _except = ""
            _result = True
        return _stat, _except, _result


class CheckGCC_AS(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindGCC_AS()
        self.name = "Binutils/Assembler"

    def check(self):
        device = SystemInfo()
        gcc_as = self.program
        if gcc_as.exe is None:
            _stat = msg_stat("err", self.name, f"GNU/Binutils Assembler not found.")
            _except = cstring(
                f"""
    TheRock needs GNU/Binutils Assembler.

        traceback: Missing GNU/Binutils Assembler program as.""",
                "err",
            )
            _result = None

        elif gcc_as.exe and device.is_windows:
            _stat = msg_stat(
                "pass", self.name, f"Found GNU/Binutils Assembler is MinGW."
            )
            _except = cstring(
                f"""
    TheRock not support using MinGW compiler toolchain on Windows.
    For Windows builds, please build in Windows OS with Visual Studio environment.
    You can find Windows build instructions here:
        https://github.com/ROCm/TheRock/blob/main/docs/development/windows_support.md

        traceback: Invalid GNU/Binutils Assembler""",
                "err",
            )
            _result = True
        elif gcc_as.exe:
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found GNU/Binutils Assembler {gcc_as.version} at {gcc_as.exe}",
            )
            _except = ""
            _result = True
        return _stat, _except, _result


class CheckLD(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindLD()
        self.name = "Binutils/Linker"

    def check(self):
        device = SystemInfo()
        ld = self.program
        if ld.exe is None:
            _stat = msg_stat("err", self.name, f"GNU/Binutils Linker not found.")
            _except = cstring(
                f"""
    TheRock needs GNU/Binutils Linker.

        traceback: Missing GNU/Binutils Linker program ld.""",
                "err",
            )
            _result = None

        elif ld.exe and device.is_windows:
            _stat = msg_stat("pass", self.name, f"Found GNU/Binutils Linker is MinGW.")
            _except = cstring(
                f"""
    TheRock not support using MinGW compiler toolchain on Windows.
    For Windows builds, please build in Windows OS with Visual Studio environment.
    You can find Windows build instructions here:
        https://github.com/ROCm/TheRock/blob/main/docs/development/windows_support.md

        traceback: Invalid GNU/Binutils Linker""",
                "err",
            )
            _result = True
        elif ld.exe:
            _stat = msg_stat(
                "pass", self.name, f"Found GNU/Binutils Linker {ld.version} at {ld.exe}"
            )
            _except = ""
            _result = True
        return _stat, _except, _result


# =====  MSVC Toolchain  =====


class CheckMSVC(CheckProgram):
    # Prebuilt libraries (e.g. wkmi.lib) may reference STL internals
    # introduced in newer MSVC versions, causing LNK2019 errors on older
    # toolchains.  Keep this in sync with validate_windows_install.ps1.
    # See https://github.com/ROCm/TheRock/issues/5029
    MIN_MSVC_VERSION = (19, 43)

    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindMSVC()
        self.name = "MSVC/VC++"

    def check(self):
        cl = self.program

        if cl.exe is None:
            _stat = msg_stat(
                "err",
                self.name,
                f"Cannot found Microsoft Optimized C/C++ compiler Driver cl.exe.",
            )
            _except = cstring(
                f"""
    We can't found any available MSVC compiler on your Windows device.
    MSVC (Microsoft Visual C/C++), The C/C++ compliler for native Windows development.
    Please re-configure your Visual Studio installed C/C++ correctly.
        Visual Studio Installer > C/C++ Development for Desktop:
        - MSVC v14X
        - MSVC ALT
        - Windows SDK 10.0.XXXXX
        - CMake for Windows
        - C++ Address Sanitizer

        traceback: Required MSVC compiler not found
    """,
                "err",
            )
            _result = None

        elif (cl.exe) and (cl.target != "x64"):
            _stat = msg_stat(
                "err", self.name, f"Found VC++ compiler targeting {cl.target}."
            )
            _except = cstring(
                f"""
    TheRock is not supported cross compile to {cl.target}.

        traceback: Unexpected VC++ compile target {cl.target}
            > {cl.exe}
    """,
                "err",
            )
            _result = None

        elif (cl.exe) and (cl.host != "x64"):
            _stat = msg_stat("err", self.name, f"Found VC++ compiler unsupported host.")
            _except = cstring(
                f"""
    TheRock project not support this VC++ host compiler.

        traceback: Unexpected VC++ compiler host {cl.host}
            > {cl.exe}
    """,
                "err",
            )
            _result = None

        else:
            # Check minimum version. cl.version is e.g. "19.42.34436 (v143)".
            _ver_match = re.match(r"(\d+)\.(\d+)", cl.version or "")
            if (
                _ver_match
                and (
                    int(_ver_match.group(1)),
                    int(_ver_match.group(2)),
                )
                < self.MIN_MSVC_VERSION
            ):
                _min = ".".join(str(v) for v in self.MIN_MSVC_VERSION)
                _stat = msg_stat(
                    "err",
                    self.name,
                    f"MSVC {cl.version} is too old (>= {_min} required)",
                )
                _except = cstring(
                    f"""
    Prebuilt libraries require MSVC >= {_min} (Visual Studio 2022 17.13+).
    Update Visual Studio or install a newer Build Tools version.

        traceback: MSVC version too old
            > expected >= {_min}, found {cl.version}
    """,
                    "err",
                )
                _result = None
            else:
                _stat = msg_stat(
                    "pass", self.name, f"Found MSVC {cl.version} at {cl.exe}"
                )
                _except = ""
                _result = True

        return _stat, _except, _result


class CheckML64(CheckProgram):
    """
    Checking MSVC's assembler, with these exceptions:
    - `ml64.exe` but with MSVC targeting wrong archs.
    - `ml64.exe` not exist but `ml.exe`, this is targeting on x86/ARM 32-bit archs.
    - Not installed.
    """

    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindML64()
        self.name = "MSVC/ML64"

    def check(self):
        ml64 = self.program
        cl_target = FindMSVC().target

        if ml64.exe and cl_target != "x64":
            _stat = msg_stat(
                "err",
                self.name,
                f"Found Microsoft Macro Assembler targeting {cl_target}.",
            )
            _except = cstring(
                f"""
    We found Microsoft Macro Assembler targeting {cl_target}.
    TheRock is not supported on targeting {cl_target}.

        traceback: Unexpected VC++ compile target {cl_target}
            > {ml64.exe}
    """,
                "err",
            )
            _result = None

        elif (ml64.exe is None) and (shutil.which("ml")):
            _stat = msg_stat(
                "err", self.name, f"Found Microsoft Macro Assembler targeting x86."
            )
            _except = cstring(
                f"""
    We found Microsoft Macro Assembler targeting x86.
    TheRock is not supported on targeting x86.

        traceback: Unexpected VC++ compile target x86
            > {shutil.which("ml")}
    """,
                "err",
            )
            _result = None

        elif ml64.exe is None:
            _stat = msg_stat(
                "err", self.name, f"Cannot found Microsoft Macro Assembler."
            )
            _except = cstring(
                f"""
    We can't found Microsoft Macro Assembler on your Windows device.
    ml64.exe is the Assembler program targeting for Windows x64.
    Please re-configure your Visual Studio installed C/C++ correctly.
        Visual Studio Installer > C/C++ Development for Desktop:
        - MSVC v14X
        - MSVC MFC
        - MSVC ALT
        - Windows SDK 10.0.XXXXX
        - CMake for Windows
        - C++ Address Sanitizer

        traceback: Required MSVC Assembler not found
    """,
                "err",
            )
            _result = None
        else:
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found Microsoft Macro Assembler {ml64.version} at {ml64.exe}",
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckLIB(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindLIB()
        self.name = "MSVC/Archiver"

    def check(self):
        lib = self.program
        if lib.exe is None:
            _stat = msg_stat("err", self.name, f"Cannot found MSVC program lib.exe.")
            _except = cstring(
                f"""
    We cannot find lib.exe (Archiver: MSVC Library Manager).
    Please check your Microsoft VC++ installation is correct, or re-check if the install is broken.

        traceback: Missing MSVC required linker compoments lib.exe
    """,
                "err",
            )
            _result = None
        else:
            _stat = msg_stat(
                "pass", self.name, f"Found MSVC Library Manager lib.exe at {lib.exe}"
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckLINK(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindLINK()
        self.name = "MSVC/Linker"

    def check(self):
        link = self.program

        if link.exe is None:
            _stat = msg_stat(
                "err", self.name, f"Cannot found Microsoft Incremental Linker."
            )
            _except = cstring(
                f"""
    We cannot find link.exe (Linker: Microsoft Incremental Linker).
    Please re-check your MSVC installation if it's broken.

        traceback: Missing MSVC required linker compoments link.exe
    """,
                "err",
            )
            _result = None
        else:
            _stat = msg_stat(
                "pass",
                self.name,
                f"Found Microsoft Incremental Linker link.exe at {link.exe}",
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckRC(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindRC()
        self.name = "Windows SDK/UCRT"

    def check(self):
        rc = self.program
        if rc.exe is None:
            _stat = msg_stat(
                "err", self.name, f"Cannot found Microsoft Resource Compiler."
            )
            _except = cstring(
                f"""
    We cannot find rc.exe (Microsoft Resource Compiler) in your Windows SDK.
    This might have Windows SDK not installed, install broken, or vcvarsXXXX.bat not load Windows SDK environment.
    Please re-configure your MSVC and Windows SDK installation.
        Visual Studio Installer > C/C++ Development for Desktop:
            - MSVC v14X
            - MSVC MFC
            - MSVC ALT
            - Windows SDK 10.0.XXXXX
            - CMake for Windows
            - C++ Address Sanitizer
        traceback: Microsoft Resource Compiler not found in Windows SDK or Windows SDK not installed
            > rc.exe: {rc.exe}
    """,
                "err",
            )
            _result = None

        else:
            _stat = msg_stat(
                "pass", self.name, f"Found Microsoft Resource Compiler at {rc.exe}"
            )
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckATL(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.name = "MSVC/ATL"

        if os.getenv("VCToolsInstallDir") is None:
            self.program = None
        else:
            _vc_inst_dir = os.getenv("VCToolsInstallDir")
            _atl_inst = Path(f"{_vc_inst_dir}/atlmfc").exists()
            self.program = _atl_inst

    def check(self):
        atl = self.program
        name = self.name
        if (atl is None) or (atl is False):
            _stat = msg_stat("err", name, f"Cannot find MSVC ATL libraries.")
            _except = cstring(
                f"""
    TheRock requires MSVC installed ATL (Active Template Library).
    Please reconfig your Visual Studio install.

        traceback: MSVC ATL not found
    """,
                "err",
            )
            _result = None
        else:
            _stat = msg_stat("pass", name, f"Found MSVC ATL.")
            _except = ""
            _result = True

        return _stat, _except, _result


class CheckVS20XX(CheckProgram):
    def __init__(self, required=True):
        super().__init__(required)
        self.program = FindVS20XX()
        self.name = "Visual Studio"

    def check(self):
        vs20xx = self.program.get_version()
        name = self.name
        if vs20xx is None:
            _stat = msg_stat(
                "err",
                name,
                f"Cannot Find Visual Studio Environment or VS version too old.",
            )
            _except = cstring(
                f"""
    TheRock needs Visual Studio 2015/2017/2019/2022. Please install it or update Visual studio Environment.

        traceback:  TheRock on Windows build requires Visual Studio 2022/2019/2017/2015 environment
    """,
                "err",
            )
            _result = None

        else:
            _stat = msg_stat("pass", name, f"Found Visual Studio {vs20xx}.")
            _except = ""
            _result = True

        return _stat, _except, _result


# System Info


class check_device(ABC):
    def __init__(self, device_info: SystemInfo):
        super().__init__()
        self.device = device_info
        self.name = "Name"

    def __call__(self):
        return self.check()

    def check(self):

        _stat = _except = _result = None
        return _stat, _except, _result


class CheckOS(check_device):
    def __init__(self, device_info):
        super().__init__(device_info)
        self.device = device_info
        self.name = "Operating System"

    def check(self):

        if self.device.is_windows and not (
            self.device.is_cygwin or self.device.is_msys2
        ):
            _stat = msg_stat(
                "pass",
                self.name,
                f"Detected OS is {self.device.OS_NAME}",
            )
            _except = ""
            _result = True

        elif self.device.is_cygwin or self.device.is_msys2:
            _stat = msg_stat("err", self.name, f"Detected OS is Cygwin/MSYS2.")
            _except = cstring(
                f"""
    We found your platform is Cygwin/MSYS2.
    TheRock only supports pure Linux and pure Windows, currently have no plan to support and ETA on it.
    Please use Visual Studio Environment to build TheRock.

        traceback: Detected on invalid Windows platform Cygwin or MSYS2
    """,
                "err",
            )
            _result = None

        elif self.device.is_linux and (not self.device.is_WSL2):
            _stat = msg_stat(
                "pass",
                self.name,
                f"Detected OS is {self.device.OS_NAME} {self.device.OS_KERNEL}",
            )
            _except = ""
            _result = True

        elif self.device.is_linux and self.device.is_WSL2:
            _stat = msg_stat(
                "err",
                self.name,
                f"Detected OS is {self.device.OS_NAME} (GNU/Linux {self.device.OS_KERNEL})",
            )
            _except = cstring(
                f"""
    Found Linux distro {self.device.OS_NAME} is WSL2 environment.
    WSL2 is not yet supported. Please use native Linux or native Windows instead.

        traceback: Detected Linux is WSL2
    """,
                "err",
            )
            _result = None

        else:
            _os = self.device.OS
            _stat = msg_stat("err", self.name, f"Detected OS is {_os}")
            _except = cstring(
                f"""
    We found your Operating System is {_os},  and it's not supported yet.
    Please select x86-64 based Linux or Windows platform for TheRock build.
    We're sorry for any inconvinence.

        traceback: Invalid Operating System {_os}
    """,
                "err",
            )
            _result = None

        return _stat, _except, _result


class CheckCPU(check_device):
    def __init__(
        self,
        device_info,
    ):
        super().__init__(device_info)
        self.device = device_info
        self.name = "CPU Arch"

    def check(self):
        _cpu_arch = self.device.CPU_ARCH

        if _cpu_arch in (
            "x64",
            "AMD64",
            "amd64",
            "Intel 64",
            "intel 64",
            "x86-64",
            "x86_64",
        ):
            _stat = msg_stat(
                "pass", self.name, f"Detected Available CPU Arch {_cpu_arch}."
            )
            _except = ""
            _result = True
        else:
            _stat = msg_stat(
                "pass", self.name, f"Detected Invalid CPU Arch {_cpu_arch}."
            )
            _except = cstring(
                f"""
    We detected unsupported CPU Architecture {_cpu_arch}.
    TheRock project currently support x86-64 Architectures, Like AMD RYZEN/Althon/EPYC or Intel Core/Core Ultra/Xeon.
    We're sorry for any inconvinence.

        traceback: Unsupported CPU Architecture {_cpu_arch}
    """,
                "err",
            )
            _result = None

        return _stat, _except, _result


class CheckDisk(check_device):
    def __init__(self, device_info):
        super().__init__(device_info)
        self.device = device_info
        self.name = "Disk Usage"

    def check(self):
        name = self.name
        _disk_avail = self.device._device_disk_stat[4]
        _disk_ratio = self.device._device_disk_stat[5]
        _disk_drive = self.device._device_disk_stat[2]
        if _disk_avail < 128 or _disk_ratio > 80:
            _stat = msg_stat("warn", self.name, f"Disk space check attention.")
            _except = cstring(
                f"""
    We've checked the workspace disk {_disk_drive} available space could be too small to build TheRock (and PyTorch).
    TheRock builds may needs massive storage for the build, and we recommends availiable disk space with 128GB and usage not over 80%.
    """,
                "warn",
            )
            _result = False

        else:
            _stat = msg_stat("pass", self.name, f"Disk space check pass.")
            _except = ""
            _result = True

        return _stat, _except, _result


class Check_Max_PATH_LIMIT(check_device):
    def __init__(self, device_info):
        super().__init__(device_info)
        self.device = device_info
        self.name = "Max PATH Limit"

    def check(self):
        _status = self.device.MAX_PATH_LENGTH
        if _status:
            _stat = msg_stat("pass", self.name, f"Windows Long PATHs Enabled.")
            _except = ""
            _result = True
        else:
            _stat = msg_stat("warn", self.name, f"Windows Long PATHs Disabled.")
            _except = cstring(
                f"""
    We found you have not enable Windows Long PATH support yet.
    This could hits unexpected error while we compile/generates long name files.
    Please enable this feature via one of these solution:
        > Using Registry Editor(regedit) or using Group Policy
        > Restart your device.

        traceback: Windows Enable Long PATH support feature is Disabled
            Registry Key Hint: HKLM:/SYSTEM/CurrentControlSet/Control/FileSystem LongPathsEnabled = 0 (DWORD)
    """,
                "warn",
            )
            _result = False

        return _stat, _except, _result