Update documentation and add python API documentation

Change-Id: Ibccf5b6a5fba81cea42e04a022deac8a3207b9b8 [ROCm/rocm_smi_lib commit: 50a079af0f]
2024-03-06 20:55:02 +01:00
parent 078f678c30
commit f0c16aa8a0
18 changed files with 1359 additions and 493 deletions
@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+"""ROCm_SMI_LIB CLI Tool Python Bindings"""
+# NOTE: You MUST call rsmiBindings.initRsmiBindings() when using this library!
+# TODO: Get most (or all) of these from rocm_smi.h to avoid mismatches and redundancy
+
+from __future__ import print_function
+import ctypes.util
+from ctypes import *
+from enum import Enum
+
+import os
+
+# Use ROCm installation path if running from standard installation
+# With File Reorg rsmiBindings.py and rsmiBindingsInit.py will be installed in 
+# /opt/rocm/libexec/rocm_smi. relative path changed accordingly.
+# if ROCM_SMI_LIB_PATH is set, we can load 'librocm_smi64.so' from that location
+#
+# Library load is wrapped in a function so prints can be hidden for PRINT_JSON mode.
+path_librocm = str()
+def initRsmiBindings(silent=False):
+    def print_silent(*args):
+        if not silent:
+            print(args)
+
+    rocm_smi_lib_path = os.getenv('ROCM_SMI_LIB_PATH')
+    if (rocm_smi_lib_path != None):
+        path_librocm = rocm_smi_lib_path
+    else:
+        path_librocm = os.path.dirname(os.path.realpath(__file__)) + '/../../@CMAKE_INSTALL_LIBDIR@/librocm_smi64.so.@VERSION_MAJOR@'
+
+    if not os.path.isfile(path_librocm):
+        print_silent('Unable to find %s . Trying /opt/rocm*' % path_librocm)
+        for root, dirs, files in os.walk('/opt', followlinks=True):
+            if 'librocm_smi64.so.@VERSION_MAJOR@' in files:
+                path_librocm = os.path.join(os.path.realpath(root), 'librocm_smi64.so.@VERSION_MAJOR@')
+        if os.path.isfile(path_librocm):
+            print_silent('Using lib from %s' % path_librocm)
+        else:
+            print('Unable to find librocm_smi64.so.@VERSION_MAJOR@')
+
+    # ----------> TODO: Support static libs as well as SO
+    try:
+        cdll.LoadLibrary(path_librocm)
+        return CDLL(path_librocm)
+    except OSError:
+        print('Unable to load the rocm_smi library.\n'\
+              'Set LD_LIBRARY_PATH to the folder containing librocm_smi64.so.@VERSION_MAJOR@\n'\
+              '{0}Please refer to https://github.com/'\
+              'RadeonOpenCompute/rocm_smi_lib for the installation guide.{1}'\
+              .format('\33[33m', '\033[0m'))
+        exit()
+
+SMI_HASH = '@PKG_VERSION_HASH@'