Added Python Build Steps

Signed-off-by: Justin Williams <Justin.Williams@amd.com>

Author: amd-juwillia

.github/workflows/amdsmi-build.yml

@@ -5,6 +5,7 @@ message("&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&")
 # Set CLI Build Directory
 set(PY_PACKAGE_DIR "amdsmi_cli")
 set(PY_CLI_INSTALL_DIR "${CMAKE_INSTALL_LIBEXECDIR}" CACHE STRING "CLI tool installation directory")
+set(PY_LIB_FROM_PKG "${PROJECT_BINARY_DIR}/py-interface/python_package/amdsmi/libamd_smi_python.so")
 
 # populate version string
 configure_file(_version.py.in ${PY_PACKAGE_DIR}/_version.py @ONLY)

projects/amdsmi/amdsmi_cli/CMakeLists.txt

@@ -29,12 +29,84 @@
 
 from pathlib import Path
 
+from typing import Optional
 current_path = os.path.dirname(os.path.abspath(__file__))
 python_lib_path = f"{current_path}/../../share/amd_smi"
 sys.path.insert(0, python_lib_path)
-# Prioritize the library from this installation over any pip-installed version
+# Only fallback to the python library if its a compatible version
+# multiple amdsmi versions installed on the system could cause issues
+# TODO Add version checking & debug to check pathing
+# Ideally we want to identify if the installed python library is incompatible and log a solution to the user
+#   LD library config or reinstall, etc...
+# The problem is coming from the switch over between the post install and pypi
+
+
+def _log_version_and_path_diagnostics():
+    """Emit best-effort diagnostics about the amdsmi Python package and the shared library location."""
+    try:
+        from amdsmi import _version  # type: ignore
+        pkg_version = getattr(_version, "__version__", "unknown")
+    except Exception as exc:  # pragma: no cover - defensive
+        pkg_version = f"unavailable ({exc})"
+    pkg_dir = Path(__file__).resolve().parent
+    lib_candidate = pkg_dir / "libamd_smi_python.so"
+    print(f"[amdsmi-cli] Python package version: {pkg_version}")
+    print(f"[amdsmi-cli] Package dir: {pkg_dir}")
+    print(f"[amdsmi-cli] Expected Python lib: {lib_candidate} (exists={lib_candidate.exists()})")
+    print(f"[amdsmi-cli] sys.path[0]: {sys.path[0]}")
+
+
+def _check_version_compatibility(expected_version: Optional[str] = None) -> None:
+    """
+    Verify that the Python package version matches the expected CLI/lib version (if provided).
+    If mismatched, log guidance and abort to avoid loading an incompatible library.
+    """
+    lib_locations = []
+    try:
+        from amdsmi import _version  # type: ignore
+        pkg_version = getattr(_version, "__version__", None)
+    except Exception:
+        _log_version_and_path_diagnostics()
+        print("[amdsmi-cli] Failed to read amdsmi Python package version; aborting to avoid incompatibility.")
+        sys.exit(1)
+
+    if expected_version and pkg_version and pkg_version != expected_version:
+        _log_version_and_path_diagnostics()
+        print(f"[amdsmi-cli] Version mismatch: expected {expected_version}, found {pkg_version}.")
+        print("[amdsmi-cli] Please install a matching amdsmi wheel from PyPI or reinstall the ROCm package,")
+        print("[amdsmi-cli] and ensure LD_LIBRARY_PATH/ldconfig points to the matching shared library.")
+        sys.exit(1)
+
+    # If the Python lib is missing, warn early with guidance.
+    pkg_dir = Path(__file__).resolve().parent
+    lib_candidate = pkg_dir / "libamd_smi_python.so"
+    if lib_candidate.exists():
+        return
+    lib_locations.append(str(lib_candidate))
+
+    # Also consider the shared install path resolved via _find_lib.py
+    try:
+        from amdsmi._find_lib import find_smi_library  # type: ignore
+        resolved = find_smi_library()
+        if resolved.exists():
+            return
+        lib_locations.append(str(resolved))
+    except Exception:
+        pass
+
+    _log_version_and_path_diagnostics()
+    print("[amdsmi-cli] Unable to locate libamd_smi_python.so in expected locations:")
+    for loc in lib_locations:
+        print(f"  - {loc}")
+    print("[amdsmi-cli] Install the amdsmi wheel that bundles the Python shared library,")
+    print("[amdsmi-cli] or adjust LD_LIBRARY_PATH/ldconfig to point to a compatible lib.")
+    sys.exit(1)
+
 
 try:
+    # TODO Add version checking & debug to check pathing
+    # The expected version string can be wired in from packaging if desired.
+    _check_version_compatibility(expected_version=None)
     from amdsmi import amdsmi_interface, amdsmi_exception
 except ImportError as e:
     print(f"Unhandled import error: {e}")

projects/amdsmi/amdsmi_cli/amdsmi_init.py

@@ -12,6 +12,11 @@ set(PY_BUILD_DIR "python_package")
 # additionally defined in pyproject.toml
 set(PY_PACKAGE_DIR "${PY_BUILD_DIR}/amdsmi")
 set(PY_WRAPPER_INSTALL_DIR "${SHARE_INSTALL_PREFIX}" CACHE STRING "Wrapper installation directory")
+set(AMDSMI_PYTHON_LIB_NAME "libamd_smi.so")
+if(BUILD_PYTHON_LIB)
+    set(AMDSMI_PYTHON_LIB_NAME "libamd_smi_python.so")
+endif()
+set(AMDSMI_PYTHON_LIB_PATH "${PROJECT_BINARY_DIR}/src/${AMDSMI_PYTHON_LIB_NAME}")
 
 # try to find clang of the right version
 set(GOOD_CLANG_FOUND FALSE)
@@ -35,6 +40,8 @@ if(NOT GOOD_CLANG_FOUND)
         AUTHOR_WARNING
             "A wrapper will not be re-generated! Using old wrapper instead.\nSet -DBUILD_WRAPPER=ON to re-build the wrapper"
     )
+    # Still need Python3 for building the wheel package
+    find_package(Python3 3.6 COMPONENTS Interpreter REQUIRED)
     add_custom_command(
         OUTPUT amdsmi_wrapper.py ${PY_PACKAGE_DIR}/amdsmi_wrapper.py
         DEPENDS ${AMD_SMI} ${CMAKE_CURRENT_SOURCE_DIR}/amdsmi_wrapper.py
@@ -54,18 +61,22 @@ else()
     add_custom_command(
         OUTPUT amdsmi.h ${CMAKE_CURRENT_SOURCE_DIR}/amdsmi_wrapper.py amdsmi_wrapper.py
                ${PY_PACKAGE_DIR}/amdsmi_wrapper.py
-        DEPENDS ${AMD_SMI} python_pre_reqs generator.py ${PROJECT_SOURCE_DIR}/include/amd_smi/amdsmi.h
+        DEPENDS ${AMD_SMI} $<$<BOOL:${BUILD_PYTHON_LIB}>:${AMD_SMI}_python> python_pre_reqs generator.py ${PROJECT_SOURCE_DIR}/include/amd_smi/amdsmi.h
         COMMAND cp ${PROJECT_SOURCE_DIR}/include/amd_smi/amdsmi.h ./
-        COMMAND ${Python3_EXECUTABLE} generator.py "$<$<BOOL:${ENABLE_ESMI_LIB}>:-e -DENABLE_ESMI_LIB>" -i amdsmi.h -l
-                ${PROJECT_BINARY_DIR}/src/libamd_smi.so -o ${CMAKE_CURRENT_SOURCE_DIR}/amdsmi_wrapper.py
+        COMMAND ${CMAKE_COMMAND} -E env AMDSMI_FIND_LIB_PATH=${CMAKE_CURRENT_BINARY_DIR}/${PY_PACKAGE_DIR}/_find_lib.py
+                ${Python3_EXECUTABLE} generator.py "$<$<BOOL:${ENABLE_ESMI_LIB}>:-e -DENABLE_ESMI_LIB>" -i amdsmi.h -l
+                ${AMDSMI_PYTHON_LIB_PATH} -o ${CMAKE_CURRENT_SOURCE_DIR}/amdsmi_wrapper.py
         COMMAND mkdir -p ${PY_PACKAGE_DIR}
         COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/amdsmi_wrapper.py ${PY_PACKAGE_DIR}/)
 endif()
 
 # populate version string
 configure_file(pyproject.toml.in ${PY_BUILD_DIR}/pyproject.toml @ONLY)
+configure_file(setup.cfg.in ${PY_BUILD_DIR}/setup.cfg @ONLY)
 configure_file(_version.py.in ${PY_PACKAGE_DIR}/_version.py @ONLY)
-configure_file(setup.py.in ${PY_BUILD_DIR}/setup.py @ONLY)
+if(BUILD_PYTHON_LIB)
+    configure_file(_find_lib.py.in ${PY_PACKAGE_DIR}/_find_lib.py @ONLY)
+endif()
 
 add_custom_target(python_wrapper DEPENDS amdsmi_wrapper.py)
 
@@ -81,24 +92,38 @@ add_custom_command(
     COMMAND ${CMAKE_COMMAND} -E copy_if_different ${PROJECT_SOURCE_DIR}/LICENSE ${PY_PACKAGE_DIR}/)
 
 # copy libamd_smi.so to allow for a self-contained python package
-add_custom_command(OUTPUT ${PY_PACKAGE_DIR}/libamd_smi.so DEPENDS ${PROJECT_BINARY_DIR}/src/libamd_smi.so
-                   COMMAND cp "${PROJECT_BINARY_DIR}/src/libamd_smi.so" ${PY_PACKAGE_DIR}/)
+add_custom_command(OUTPUT ${PY_PACKAGE_DIR}/${AMDSMI_PYTHON_LIB_NAME} DEPENDS ${AMDSMI_PYTHON_LIB_PATH}
+                   COMMAND cp "${AMDSMI_PYTHON_LIB_PATH}" ${PY_PACKAGE_DIR}/)
 
 add_custom_target(
     python_package ALL
     DEPENDS ${PY_BUILD_DIR}/pyproject.toml
-            ${PY_BUILD_DIR}/setup.py
+            ${PY_BUILD_DIR}/setup.cfg
             ${PY_PACKAGE_DIR}/_version.py
             ${PY_PACKAGE_DIR}/__init__.py
             ${PY_PACKAGE_DIR}/amdsmi_exception.py
             ${PY_PACKAGE_DIR}/amdsmi_interface.py
             ${PY_PACKAGE_DIR}/README.md
             ${PY_PACKAGE_DIR}/LICENSE
-            ${PY_PACKAGE_DIR}/libamd_smi.so)
+            ${PY_PACKAGE_DIR}/${AMDSMI_PYTHON_LIB_NAME}
+            $<$<BOOL:${BUILD_PYTHON_LIB}>:${PY_PACKAGE_DIR}/_find_lib.py>)
+if(BUILD_PYTHON_LIB)
+    add_dependencies(python_package ${AMD_SMI}_python)
+endif()
+
+# Build a wheel into the binary dir (no deps, local artifacts only)
+add_custom_target(
+    python_wheel ALL
+    DEPENDS python_package
+    COMMAND ${CMAKE_COMMAND} -E env PYTHONPATH=${CMAKE_CURRENT_BINARY_DIR}/${PY_BUILD_DIR}
+            ${Python3_EXECUTABLE} -m pip wheel --no-deps -w ${CMAKE_CURRENT_BINARY_DIR}/${PY_BUILD_DIR}
+            ${CMAKE_CURRENT_BINARY_DIR}/${PY_BUILD_DIR}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${PY_BUILD_DIR}
+    COMMENT "Building amdsmi wheel without dependencies")
 
 install(
     FILES ${CMAKE_CURRENT_BINARY_DIR}/${PY_BUILD_DIR}/pyproject.toml
-          ${CMAKE_CURRENT_BINARY_DIR}/${PY_BUILD_DIR}/setup.py ${CMAKE_CURRENT_BINARY_DIR}/${PY_PACKAGE_DIR}/_version.py
+          ${CMAKE_CURRENT_BINARY_DIR}/${PY_PACKAGE_DIR}/_version.py
     DESTINATION ${PY_WRAPPER_INSTALL_DIR}
     COMPONENT dev)
 

projects/amdsmi/py-interface/CMakeLists.txt

@@ -0,0 +1,10 @@
+from pathlib import Path
+
+
+def find_smi_library() -> Path:
+    here = Path(__file__).resolve().parent
+    candidate = here / "libamd_smi_python.so"
+    if candidate.exists():
+        return candidate
+    # fall back to the default shared library name for developer builds
+    return here / "libamd_smi.so"