Files
rocm-systems/docs/install/build.md
T
Poag, Charis b5a43b7744 [SWDEV-528647/SWDEV-528450] Reduce API load times and libdrm/libdrm_amdgpu dynamic loading (#333)
Changes:
- Removed libdrm/libdrm_amdgpu dependencies
- Added/updated new internal libdrm/libdrm_amdgpu/xf86drm APIs
  to allow our APIs to reference before dynamic loading
  the libdrm/libdrm_amdgpu libraries:
  1. amdgpu_drm.h to what's seen in mainline
  2. Added xf86drm.h to whats seen in mainline
- Modified internal DRM capabilities:
  1. Require each API to independently connect to libdrm/libdrm_amdgpu
     + validate API handles reponses accordingly
  2. Initialization of AMD SMI no longer has as strong of a tie to
     libdrm
- Updated internal implementations of several APIs which have
connections to libdrm/libdrm_amdgpu or APIs which have conflicts
with open libdrm/libdrm_amdgpu connections:
  1. amdsmi_init()
  2. amdsmi_get_gpu_vram_usage()
  3. amdsmi_get_gpu_asic_info()
  4. amdsmi_get_gpu_vram_info()
  5. amdsmi_get_gpu_vbios_info()
  6. amdsmi_get_gpu_driver_info()
  7. amdsmi_get_gpu_virtualization_mode()
  8. amdsmi_set_gpu_memory_partition()
  9. amdsmi_set_gpu_memory_partition_mode()
- Cleaned up effected tests/APIs

Change-Id: I96e2cf1b06b0cfee1b01a5e991ccc6116c4245a8
2025-05-02 21:58:53 -05:00

2.9 KiB

myst
myst
html_meta
description lang=en keywords
How to build AMD SMI from source. system, management, interface, contribute, contributing, ROCm, develop, testing

Building AMD SMI

This section describes the prerequisites and steps to build AMD SMI from source.

(build_reqs)=

Required software

To build the AMD SMI library, the following components are required. Note that the software versions specified were used during development; earlier versions are not guaranteed to work.

  • CMake (v3.15.0 or later) -- python3 -m pip install cmake
  • g++ (v5.4.0 or later)
  • libdrm-dev (for Ubuntu and Debian)
  • libdrm-devel (for RPM-based distributions)

In order to build the AMD SMI Python package, the following components are required:

  • Python (3.6.8 or later)
  • virtualenv -- python3 -m pip install virtualenv

Build steps

  1. Clone the AMD SMI repository to your local Linux machine.

    git clone https://github.com/ROCm/amdsmi.git
    
  2. The default installation location for the library and headers is /opt/rocm. Before installation, any old ROCm directories should be deleted:

    • /opt/rocm
    • /opt/rocm-<version_number>
  3. Build the library by following the typical CMake build sequence (run as root user or use sudo before make install command); for instance:

    mkdir -p build
    cd build
    cmake ..
    make -j $(nproc)
    make install
    

    The built library is located in the build/ directory. To build the rpm and deb packages use the following command:

    make package
    

(rebuild_py_wrapper)=

Rebuild the Python wrapper

The Python wrapper for the AMD SMI library is found in the auto-generated file py-interface/amdsmi_wrapper.py. It is essential to regenerate this wrapper whenever there are changes to the C++ API. It is not regenerated automatically.

To regenerate the wrapper, use the following command.

./update_wrapper.sh

After this command, the file in py-interface/amdsmi_wrapper.py will be updated on compile.

You need Docker installed on your system to regenerate the Python wrapper.

(build_tests)=

Build the tests

To verify the build and capabilities of AMD SMI on your system, as well as to see practical examples of its usage, you can build and run the available tests in the repository. Follow these steps to build the tests:

mkdir -p build
cd build
cmake -DBUILD_TESTS=ON ..
make -j $(nproc)

(run_tests)=

Run the tests

Once the tests are built, you can run them by executing the amdsmitst program. The executable can be found at build/tests/amd_smi_test/.

(build_docs)=

Build the docs

To build the documentation, follow the instructions at Building documentation.