feature: Add more APIs to L0 Sysman python binding

Added following APIs to python binding:

1. zesDevicePciGetProperties
2. zesDevicePciGetStats
3. zesDeviceEccAvailable
4. zesDeviceEccConfigurable
5. zesDeviceGetEccState
6. zesDeviceSetEccState
7. zesPowerGetLimitsExt
8. zesPowerSetLimitsExt
9. zesFrequencyGetAvailableClocks
10. zesFrequencyGetRange
11. zesFrequencySetRange
12. zesFrequencyGetThrottleTime
13. zesDevicePciGetState
14. zesPowerGetProperties
15. zesPowerGetUsage

Signed-off-by: Aviral Nigam <aviral.nigam@intel.com>

Author: aviralni

bindings/sysman/python/source/pyzes.py

@@ -9,6 +9,7 @@
 # Python bindings for the libze_intel_gpu.so / ze_intel_gpu.dll library
 ##
 
+import os
 import sys
 import threading
 from ctypes import *
@@ -771,6 +772,12 @@ class zes_engine_stats_t(_PrintableStructure):
 _getFunctionPointerList: Dict[str, Any] = dict()
 
 
+def is_root_user():
+    """Return whether the current user has root privileges on platforms that support it."""
+    geteuid = getattr(os, "geteuid", None)
+    return bool(geteuid and geteuid() == 0)
+
+
 def getFunctionPointerList(name):
     if name in _getFunctionPointerList:
         return _getFunctionPointerList[name]
@@ -1108,6 +1115,9 @@ def zesMemoryGetState(hMemory, pState):
     Returns:
       ze_result_t - return code only, state is filled into pState
     """
+    if not is_root_user():
+        return ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
+
     funcPtr = getFunctionPointerList("zesMemoryGetState")
     funcPtr.argtypes = [zes_mem_handle_t, POINTER(zes_mem_state_t)]
     funcPtr.restype = ze_result_t
@@ -1127,6 +1137,9 @@ def zesMemoryGetBandwidth(hMemory, pBandwidth):
     Returns:
       ze_result_t - return code only, bandwidth is filled into pBandwidth
     """
+    if not is_root_user():
+        return ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
+
     funcPtr = getFunctionPointerList("zesMemoryGetBandwidth")
     funcPtr.argtypes = [zes_mem_handle_t, POINTER(zes_mem_bandwidth_t)]
     funcPtr.restype = ze_result_t
@@ -1170,6 +1183,9 @@ def zesPowerGetEnergyCounter(hPower, pEnergy):
     Returns:
       ze_result_t - return code only, energy counter is filled into pEnergy
     """
+    if not is_root_user():
+        return ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
+
     funcPtr = getFunctionPointerList("zesPowerGetEnergyCounter")
     funcPtr.argtypes = [zes_pwr_handle_t, POINTER(zes_power_energy_counter_t)]
     funcPtr.restype = ze_result_t
@@ -1478,6 +1494,9 @@ def zesTemperatureGetState(hTemperature, pTemperature):
     Returns:
       ze_result_t - return code only, temperature is filled into pTemperature
     """
+    if not is_root_user():
+        return ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
+
     funcPtr = getFunctionPointerList("zesTemperatureGetState")
     funcPtr.argtypes = [zes_temp_handle_t, POINTER(c_double)]
     funcPtr.restype = ze_result_t
@@ -1544,6 +1563,9 @@ def zesEngineGetActivity(hEngine, pStats):
     Returns:
       ze_result_t - return code only, stats are filled into pStats
     """
+    if not is_root_user():
+        return ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS
+
     funcPtr = getFunctionPointerList("zesEngineGetActivity")
     funcPtr.argtypes = [zes_engine_handle_t, POINTER(zes_engine_stats_t)]
     funcPtr.restype = ze_result_t

bindings/sysman/python/test/unit_tests/test_engine.py

@@ -21,7 +21,6 @@
 
 @patch("pyzes.getFunctionPointerList")
 class TestEngineFunctions(unittest.TestCase):
-
     def setUp(self):
         import pyzes
 
@@ -92,14 +91,28 @@ def mock_get_activity(engine_handle, stats_ptr):
 
         engine_handle = self.pyzes.zes_engine_handle_t()
         engine_stats = self.pyzes.zes_engine_stats_t()
-        result = self.pyzes.zesEngineGetActivity(engine_handle, byref(engine_stats))
+        with patch("pyzes.is_root_user", return_value=True):
+            result = self.pyzes.zesEngineGetActivity(engine_handle, byref(engine_stats))
 
         self.assertEqual(result, self.pyzes.ZE_RESULT_SUCCESS)
         self.assertEqual(engine_stats.activeTime, mock_active_time)
         self.assertEqual(engine_stats.timestamp, mock_timestamp)
         mock_get_func.assert_called_with("zesEngineGetActivity")
         mock_func.assert_called_once()
 
+    @patch("pyzes.is_root_user", return_value=False)
+    def test_GivenNonRootUserWhenCallingZesEngineGetActivityThenReturnInsufficientPermissions(
+        self, mock_is_root_user, mock_get_func
+    ):
+        engine_handle = self.pyzes.zes_engine_handle_t()
+        engine_stats = self.pyzes.zes_engine_stats_t()
+
+        result = self.pyzes.zesEngineGetActivity(engine_handle, byref(engine_stats))
+
+        self.assertEqual(result, self.pyzes.ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS)
+        mock_is_root_user.assert_called_once_with()
+        mock_get_func.assert_not_called()
+
 
 if __name__ == "__main__":
     unittest.main()

bindings/sysman/python/test/unit_tests/test_memory.py

@@ -21,7 +21,6 @@
 
 @patch("pyzes.getFunctionPointerList")
 class TestMemoryFunctions(unittest.TestCase):
-
     def setUp(self):
         import pyzes
 
@@ -108,7 +107,8 @@ def mock_get_state(memory_handle, state_ptr):
 
         memory_handle = self.pyzes.zes_mem_handle_t()
         mem_state = self.pyzes.zes_mem_state_t()
-        result = self.pyzes.zesMemoryGetState(memory_handle, byref(mem_state))
+        with patch("pyzes.is_root_user", return_value=True):
+            result = self.pyzes.zesMemoryGetState(memory_handle, byref(mem_state))
 
         self.assertEqual(result, self.pyzes.ZE_RESULT_SUCCESS)
         self.assertEqual(mem_state.health, mock_health)
@@ -117,6 +117,19 @@ def mock_get_state(memory_handle, state_ptr):
         mock_get_func.assert_called_with("zesMemoryGetState")
         mock_func.assert_called_once()
 
+    @patch("pyzes.is_root_user", return_value=False)
+    def test_GivenNonRootUserWhenCallingZesMemoryGetStateThenReturnInsufficientPermissions(
+        self, mock_is_root_user, mock_get_func
+    ):
+        memory_handle = self.pyzes.zes_mem_handle_t()
+        mem_state = self.pyzes.zes_mem_state_t()
+
+        result = self.pyzes.zesMemoryGetState(memory_handle, byref(mem_state))
+
+        self.assertEqual(result, self.pyzes.ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS)
+        mock_is_root_user.assert_called_once_with()
+        mock_get_func.assert_not_called()
+
     def test_GivenValidMemoryHandleWhenCallingZesMemoryGetBandwidthThenCallSucceedsWithBandwidth(
         self, mock_get_func
     ):
@@ -137,7 +150,10 @@ def mock_get_bandwidth(memory_handle, bandwidth_ptr):
 
         memory_handle = self.pyzes.zes_mem_handle_t()
         mem_bandwidth = self.pyzes.zes_mem_bandwidth_t()
-        result = self.pyzes.zesMemoryGetBandwidth(memory_handle, byref(mem_bandwidth))
+        with patch("pyzes.is_root_user", return_value=True):
+            result = self.pyzes.zesMemoryGetBandwidth(
+                memory_handle, byref(mem_bandwidth)
+            )
 
         self.assertEqual(result, self.pyzes.ZE_RESULT_SUCCESS)
         self.assertEqual(mem_bandwidth.readCounter, mock_read_counter)
@@ -147,6 +163,19 @@ def mock_get_bandwidth(memory_handle, bandwidth_ptr):
         mock_get_func.assert_called_with("zesMemoryGetBandwidth")
         mock_func.assert_called_once()
 
+    @patch("pyzes.is_root_user", return_value=False)
+    def test_GivenNonRootUserWhenCallingZesMemoryGetBandwidthThenReturnInsufficientPermissions(
+        self, mock_is_root_user, mock_get_func
+    ):
+        memory_handle = self.pyzes.zes_mem_handle_t()
+        mem_bandwidth = self.pyzes.zes_mem_bandwidth_t()
+
+        result = self.pyzes.zesMemoryGetBandwidth(memory_handle, byref(mem_bandwidth))
+
+        self.assertEqual(result, self.pyzes.ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS)
+        mock_is_root_user.assert_called_once_with()
+        mock_get_func.assert_not_called()
+
 
 if __name__ == "__main__":
     unittest.main()

bindings/sysman/python/test/unit_tests/test_power.py

@@ -65,14 +65,28 @@ def mock_get_energy(power_handle, energy_ptr):
         power_handle = self.pyzes.zes_pwr_handle_t()
         energy = self.pyzes.zes_power_energy_counter_t()
 
-        result = self.pyzes.zesPowerGetEnergyCounter(power_handle, byref(energy))
+        with patch("pyzes.is_root_user", return_value=True):
+            result = self.pyzes.zesPowerGetEnergyCounter(power_handle, byref(energy))
 
         self.assertEqual(result, self.pyzes.ZE_RESULT_SUCCESS)
         self.assertEqual(energy.energy, mock_energy)
         self.assertEqual(energy.timestamp, mock_timestamp)
         mock_get_func.assert_called_with("zesPowerGetEnergyCounter")
         mock_func.assert_called_once()
 
+    @patch("pyzes.is_root_user", return_value=False)
+    def test_GivenNonRootUserWhenCallingZesPowerGetEnergyCounterThenReturnInsufficientPermissions(
+        self, mock_is_root_user, mock_get_func
+    ):
+        power_handle = self.pyzes.zes_pwr_handle_t()
+        energy = self.pyzes.zes_power_energy_counter_t()
+
+        result = self.pyzes.zesPowerGetEnergyCounter(power_handle, byref(energy))
+
+        self.assertEqual(result, self.pyzes.ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS)
+        mock_is_root_user.assert_called_once_with()
+        mock_get_func.assert_not_called()
+
     def test_GivenValidPowerHandleWhenCallingZesPowerGetUsageThenCallSucceedsWithUsageData(
         self, mock_get_func
     ):

bindings/sysman/python/test/unit_tests/test_temperature.py

@@ -137,13 +137,27 @@ def mock_get_state(temp_handle, temperature_ptr):
 
         temp_handle = self.pyzes.zes_temp_handle_t()
         temperature = c_double()
-        result = self.pyzes.zesTemperatureGetState(temp_handle, byref(temperature))
+        with patch("pyzes.is_root_user", return_value=True):
+            result = self.pyzes.zesTemperatureGetState(temp_handle, byref(temperature))
 
         self.assertEqual(result, self.pyzes.ZE_RESULT_SUCCESS)
         self.assertEqual(temperature.value, mock_temperature)
         mock_get_func.assert_called_with("zesTemperatureGetState")
         mock_func.assert_called_once()
 
+    @patch("pyzes.is_root_user", return_value=False)
+    def test_GivenNonRootUserWhenCallingZesTemperatureGetStateThenReturnInsufficientPermissions(
+        self, mock_is_root_user, mock_get_func
+    ):
+        temp_handle = self.pyzes.zes_temp_handle_t()
+        temperature = c_double()
+
+        result = self.pyzes.zesTemperatureGetState(temp_handle, byref(temperature))
+
+        self.assertEqual(result, self.pyzes.ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS)
+        mock_is_root_user.assert_called_once_with()
+        mock_get_func.assert_not_called()
+
 
 if __name__ == "__main__":
     unittest.main()