AMD SMI documentation

AMD SMI documentation#

AMD SMI LIB is a library that enables you to manage and monitor AMD Virtualization Enabled GPUs, as well as monitor AMD Pensando and Broadcom NICs. It is a thread safe, extensible C based library. The library exposes C, Python, and Go API interfaces.

Note

This is the AMD SMI for SR-IOV Linux host only. If you are looking for Linux baremetal or SR-IOV Linux guest AMD SMI, please go to the AMD SMI documentation.

Some of the features that are exposed in the library are:

Query static information about the GPU (ASIC, framebuffer etc.)
Query information about the FW on the physical function
Query information about the virtual functions on the GPU
Query GPU metrics (temperature, clocks, usage etc.)
Set GPU configuration (partitioning modes, FB sharing modes, power cap etc.)
GPU reset and clear VF FB (on MI products)
Query NIC information (ASIC, bus, NUMA, driver, firmware, ports, RDMA devices) and statistics, link topology between processors (NIC-to-GPU)
To run the AMD SMI library, the Linux PF driver needs to be installed.

There are three parts to the AMD SMI library interface:

C interface
- Consists of C function declarations.
- The client can call these to query information and configure settings on the Linux host machine.
- The C interface can be used by the clients to build applications in C/C++ by using this interface and library binary.
Python interface
- Consists of Python function declarations.
- These directly call the C interface.
- The client can use the Python interface to build applications in Python.
Go interface
- Consists of Go function declarations.
- These directly call the C interface via CGO.
- The client can use the Go interface to build applications in Go.

AMD SMI tool is a command line utility that utilizes AMD SMI Library APIs to monitor and configure AMD GPUs and NICs. The tool is used to monitor AMD’s GPUs status in a virtualization environment in both host OS and guest VM, as well as in a bare metal environment for both Windows and Linux Operating Systems. The tool outputs GPU/driver information in plain text, in JSON, or in CSV formats while it can also show the info in the console or save to the specified output file.

The tool can be used to:

Query static information about the GPU (ASIC, framebuffer etc.)
Query information about the FW on the physical function
Query information about the virtual functions on the GPU
Query GPU metrics (temperature, clocks, usage etc.)
Set GPU configuration (partitioning modes, FB sharing modes, power cap etc.)
Reset GPU and clear VF FB (on MI products)
List NICs and query their static information, firmware, port and RDMA statistics, and link topology between processors (NIC-to-GPU)

For additional information on build, installation, usage, versioning and API references, please refer to the sections below:

Install

How to

Reference

General

Library and CLI tool versioning

The information contained herein is for informational purposes only, and is subject to change without notice. While every precaution has been taken in the preparation of this document, it may contain technical inaccuracies, omissions and typographical errors, and AMD is under no obligation to update or otherwise correct this information. Advanced Micro Devices, Inc. makes no representations or warranties with respect to the accuracy or completeness of the contents of this document, and assumes no liability of any kind, including the implied warranties of noninfringement, merchantability or fitness for particular purposes, with respect to the operation or use of AMD hardware, software or other products described herein.

AMD, the AMD Arrow logo, and combinations thereof are trademarks of Advanced Micro Devices, Inc. Other product names used in this publication are for identification purposes only and may be trademarks of their respective companies.