Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions projects/rocm-smi-lib/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ Full documentation for rocm_smi_lib is available at [https://rocm.docs.amd.com/]

***All information listed below is for reference and subject to change.***

## rocm_smi_lib for ROCm 10.0.0

### Changed

- **Added `ROCM_SMI_DISABLE` build gate**.
- Setting `ROCM_SMI_DISABLE=True` (environment or CMake cache variable) skips building and installing rocm-smi-lib entirely. rocm-smi-lib is no longer included in TheRock builds; it can still be built from source if desired. Use [AMD SMI](https://github.com/ROCm/amdsmi) instead.

## rocm_smi_lib for ROCm 7.2.0

### Added
Expand Down
22 changes: 22 additions & 0 deletions projects/rocm-smi-lib/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,28 @@ message("&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&")
cmake_minimum_required(VERSION 3.14)
project(rocm_smi_lib)

# ROCm SMI is deprecated in favor of AMD SMI. Builds (including TheRock) set
# ROCM_SMI_DISABLE=True to skip building the library entirely. Honor both the
# cache variable and the environment variable of the same name.
if(DEFINED ENV{ROCM_SMI_DISABLE} AND NOT DEFINED ROCM_SMI_DISABLE)
set(ROCM_SMI_DISABLE
"$ENV{ROCM_SMI_DISABLE}"
CACHE BOOL
"Deprecated: skip building rocm-smi-lib"
FORCE
)
endif()
option(ROCM_SMI_DISABLE "Deprecated: skip building rocm-smi-lib" OFF)

if(ROCM_SMI_DISABLE)
message(
WARNING
"rocm-smi-lib is deprecated and ROCM_SMI_DISABLE is set; skipping build. "
"Use AMD SMI instead: https://github.com/ROCm/amdsmi"
)
return()
endif()

set(ROCM_SMI_LIBS_TARGET "rocm_smi_libraries")

set(BUILD_SHARED_LIBS ON CACHE BOOL "Build shared library (.so) or not.")
Expand Down
2 changes: 2 additions & 0 deletions projects/rocm-smi-lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Starting with ROCm 7.0, only critical bug fixes will be applied to ROCm-SMI.
For a seamless experience and continued support, please switch to [AMD-SMI](https://github.com/ROCm/amdsmi).

As of ROCm 10.0, ROCm-SMI is no longer included in TheRock builds. It can still be built from source if desired (see the [installation guide](https://rocm.docs.amd.com/projects/rocm_smi_lib/en/latest/install/install.html)).

## Use C++ in ROCm SMI

### Device Indices
Expand Down
3 changes: 3 additions & 0 deletions projects/rocm-smi-lib/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ For more information, refer to `<https://github.com/ROCm/rocm_smi_lib>`__.

AMD SMI will replace ``rocm_smi_lib`` over time. We recommend that users transition to AMD SMI.

As of ROCm 10.0, ROCm SMI is no longer included in TheRock builds. It can still be built from source if desired
(see the :doc:`installation guide <./install/install>`), but new deployments should use AMD SMI.

For more information, refer to `<https://github.com/ROCm/amdsmi>`__ and the :doc:`AMD SMI documentation <amdsmi:index>`.

.. grid:: 2
Expand Down
17 changes: 17 additions & 0 deletions projects/rocm-smi-lib/docs/install/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,23 @@ After the ROCm SMI library git repository is cloned to a local Linux machine, us

The built library will appear in the `build` folder.

Disabling the build
===================

Because ROCm SMI is deprecated, its build can be skipped entirely. Set
``ROCM_SMI_DISABLE=True`` as either an environment variable or a CMake cache
variable and the project configures to a no-op, building and installing nothing.
As of ROCm 10.0, TheRock uses this to exclude ROCm SMI from the ROCm stack; it
can still be built from source if desired.
Comment thread
gabrpham marked this conversation as resolved.
Resolved

.. code-block:: shell

# As an environment variable
ROCM_SMI_DISABLE=True cmake ..

# Or as a CMake cache variable
cmake .. -DROCM_SMI_DISABLE=True

To build the rpm and deb packages follow the above steps with:

.. code-block:: shell
Expand Down
Loading