GPU monitoring (percentage and time) in Darwin/macOS

linux/GPUMeter.c → GPUMeter.c

@@ -7,29 +7,15 @@ in the source distribution for its full text.
 
 #include "config.h" // IWYU pragma: keep
 
-#include "linux/GPUMeter.h"
+#include "GPUMeter.h"
 
 #include "CRT.h"
+#include "Platform.h"
 #include "RichString.h"
-#include "linux/LinuxMachine.h"
+#include "XUtils.h"
 
 
 static size_t activeMeters;
-
-bool GPUMeter_active(void) {
-   return activeMeters > 0;
-}
-
-struct EngineData {
-   const char* key;  /* owned by LinuxMachine */
-   unsigned long long int timeDiff;
-};
-
-static struct EngineData GPUMeter_engineData[4];
-static unsigned long long int prevResidueTime, curResidueTime;
-static double totalUsage;
-static unsigned long long int totalGPUTimeDiff;
-
 static const int GPUMeter_attributes[] = {
    GPU_ENGINE_1,
    GPU_ENGINE_2,
@@ -38,6 +24,10 @@ static const int GPUMeter_attributes[] = {
    GPU_RESIDUE,
 };
 
+bool GPUMeter_active(void) {
+   return activeMeters > 0;
+}
+
 static int humanTimeUnit(char* buffer, size_t size, unsigned long long int value) {
 
    if (value < 1000)
@@ -84,71 +74,35 @@ static int humanTimeUnit(char* buffer, size_t size, unsigned long long int value
 
 static void GPUMeter_updateValues(Meter* this) {
    const Machine* host = this->host;
-   const LinuxMachine* lhost = (const LinuxMachine*) host;
-   const GPUEngineData* gpuEngineData;
    char* buffer = this->txtBuffer;
    size_t size = sizeof(this->txtBuffer);
-   int written;
-   unsigned int i;
-   uint64_t monotonictimeDelta;
 
-   assert(ARRAYSIZE(GPUMeter_engineData) + 1 == ARRAYSIZE(GPUMeter_attributes));
-
-   totalGPUTimeDiff = saturatingSub(lhost->curGpuTime, lhost->prevGpuTime);
-   monotonictimeDelta = host->monotonicMs - host->prevMonotonicMs;
-
-   prevResidueTime = curResidueTime;
-   curResidueTime = lhost->curGpuTime;
-
-   for (gpuEngineData = lhost->gpuEngineData, i = 0; gpuEngineData && i < ARRAYSIZE(GPUMeter_engineData); gpuEngineData = gpuEngineData->next, i++) {
-      GPUMeter_engineData[i].key      = gpuEngineData->key;
-      GPUMeter_engineData[i].timeDiff = saturatingSub(gpuEngineData->curTime, gpuEngineData->prevTime);
-
-      curResidueTime = saturatingSub(curResidueTime, gpuEngineData->curTime);
-
-      this->values[i] = 100.0 * GPUMeter_engineData[i].timeDiff / (1000 * 1000) / monotonictimeDelta;
+   if (!isNonnegative(host->totalGPUUsage)) {
+      this->values[0] = 0;
+      int written = xSnprintf(buffer, size, "N/A");
+      METER_BUFFER_CHECK(buffer, size, written);
+      return;
    }
 
-   this->values[ARRAYSIZE(GPUMeter_engineData)] = 100.0 * saturatingSub(curResidueTime, prevResidueTime) / (1000 * 1000) / monotonictimeDelta;
-
-   totalUsage = 100.0 * totalGPUTimeDiff / (1000 * 1000) / monotonictimeDelta;
-   written = snprintf(buffer, size, "%.1f", totalUsage);
+   int written = xSnprintf(buffer, size, "%.1f", host->totalGPUUsage);
    METER_BUFFER_CHECK(buffer, size, written);
-
    METER_BUFFER_APPEND_CHR(buffer, size, '%');
 }
 
 static void GPUMeter_display(const Object* cast, RichString* out) {
+   const Meter* this = (const Meter*)cast;
+   const Machine* host = this->host;
+
    char buffer[50];
    int written;
-   const Meter* this = (const Meter*)cast;
-   unsigned int i;
 
    RichString_writeAscii(out, CRT_colors[METER_TEXT], ":");
-   written = xSnprintf(buffer, sizeof(buffer), "%4.1f", totalUsage);
+   written = xSnprintf(buffer, sizeof(buffer), "%4.1f", host->totalGPUUsage);
    RichString_appendnAscii(out, CRT_colors[METER_VALUE], buffer, written);
    RichString_appendnAscii(out, CRT_colors[METER_TEXT], "%(", 2);
-   written = humanTimeUnit(buffer, sizeof(buffer), totalGPUTimeDiff);
+   written = humanTimeUnit(buffer, sizeof(buffer), host->totalGPUTimeDiff);
    RichString_appendnAscii(out, CRT_colors[METER_VALUE], buffer, written);
    RichString_appendnAscii(out, CRT_colors[METER_TEXT], ")", 1);
-
-   for (i = 0; i < ARRAYSIZE(GPUMeter_engineData); i++) {
-      if (!GPUMeter_engineData[i].key)
-         break;
-
-      RichString_appendnAscii(out, CRT_colors[METER_TEXT], " ", 1);
-      RichString_appendAscii(out, CRT_colors[METER_TEXT], GPUMeter_engineData[i].key);
-      RichString_appendnAscii(out, CRT_colors[METER_TEXT], ":", 1);
-      if (isNonnegative(this->values[i]))
-         written = xSnprintf(buffer, sizeof(buffer), "%4.1f", this->values[i]);
-      else
-         written = xSnprintf(buffer, sizeof(buffer), " N/A");
-      RichString_appendnAscii(out, CRT_colors[METER_VALUE], buffer, written);
-      RichString_appendnAscii(out, CRT_colors[METER_TEXT], "%(", 2);
-      written = humanTimeUnit(buffer, sizeof(buffer), GPUMeter_engineData[i].timeDiff);
-      RichString_appendnAscii(out, CRT_colors[METER_VALUE], buffer, written);
-      RichString_appendnAscii(out, CRT_colors[METER_TEXT], ")", 1);
-   }
 }
 
 static void GPUMeter_init(Meter* this ATTR_UNUSED) {
@@ -171,7 +125,7 @@ const MeterClass GPUMeter_class = {
    .updateValues = GPUMeter_updateValues,
    .defaultMode = BAR_METERMODE,
    .supportedModes = METERMODE_DEFAULT_SUPPORTED,
-   .maxItems = ARRAYSIZE(GPUMeter_engineData) + 1,
+   .maxItems = ARRAYSIZE(GPUMeter_attributes),
    .total = 100.0,
    .attributes = GPUMeter_attributes,
    .name = "GPU",

linux/GPUMeter.h → GPUMeter.h

@@ -11,6 +11,10 @@ in the source distribution for its full text.
 
 #include "Meter.h"
 
+struct EngineData {
+   const char* key;
+   unsigned long long int timeDiff;
+};
 
 extern const MeterClass GPUMeter_class;
 

Machine.h

@@ -64,6 +64,9 @@ typedef struct Machine_ {
    unsigned int activeCPUs;
    unsigned int existingCPUs;
 
+   double totalGPUUsage;
+   unsigned long long int totalGPUTimeDiff;
+
    UsersTable* usersTable;
    uid_t htopUserId;
    uid_t maxUserId;  /* recently observed */
@@ -94,4 +97,6 @@ void Machine_scan(Machine* this);
 
 void Machine_scanTables(Machine* this);
 
+void Machine_scanGPUUsage(Machine* super);
+
 #endif

Makefile.am

@@ -53,6 +53,7 @@ myhtopsources = \
 	EnvScreen.c \
 	FileDescriptorMeter.c \
 	FunctionBar.c \
+	GPUMeter.c \
 	Hashtable.c \
 	Header.c \
 	HeaderOptionsPanel.c \
@@ -119,6 +120,7 @@ myhtopheaders = \
 	EnvScreen.h \
 	FileDescriptorMeter.h \
 	FunctionBar.h \
+	GPUMeter.h \
 	Hashtable.h \
 	Header.h \
 	HeaderLayout.h \
@@ -174,7 +176,6 @@ linux_platform_headers = \
 	generic/uname.h \
 	linux/CGroupUtils.h \
 	linux/GPU.h \
-	linux/GPUMeter.h \
 	linux/HugePageMeter.h \
 	linux/IOPriority.h \
 	linux/IOPriorityPanel.h \
@@ -200,7 +201,6 @@ linux_platform_sources = \
 	generic/uname.c \
 	linux/CGroupUtils.c \
 	linux/GPU.c \
-	linux/GPUMeter.c \
 	linux/HugePageMeter.c \
 	linux/IOPriorityPanel.c \
 	linux/LibSensors.c \

darwin/DarwinMachine.c

@@ -16,6 +16,8 @@ in the source distribution for its full text.
 #include <unistd.h>
 #include <sys/mman.h>
 #include <sys/sysctl.h>
+#include <CoreFoundation/CoreFoundation.h>
+#include <IOKit/IOKitLib.h>
 
 #include "CRT.h"
 #include "Machine.h"
@@ -84,6 +86,7 @@ void Machine_scan(Machine* super) {
    DarwinMachine_allocateCPULoadInfo(&host->curr_load);
    DarwinMachine_getVMStats(host);
    openzfs_sysctl_updateArcStats(&host->zfs);
+   Machine_scanGPUUsage(super);
 }
 
 Machine* Machine_new(UsersTable* usersTable, uid_t userId) {
@@ -105,12 +108,23 @@ Machine* Machine_new(UsersTable* usersTable, uid_t userId) {
    openzfs_sysctl_init(&this->zfs);
    openzfs_sysctl_updateArcStats(&this->zfs);
 
+   this->GPUService = IOServiceGetMatchingService(kIOMainPortDefault, IOServiceMatching("IOGPU"));
+   if(!this->GPUService) {
+      CRT_debug("Cannot create macOS GPUService");
+   }
+
+   /* Initialize GPU metric read-out */
+   super->totalGPUUsage = NAN;
+   super->totalGPUTimeDiff = (unsigned long long)-1;
+
    return super;
 }
 
 void Machine_delete(Machine* super) {
    DarwinMachine* this = (DarwinMachine*) super;
 
+   IOObjectRelease(this->GPUService);
+
    DarwinMachine_freeCPULoadInfo(&this->prev_load);
 
    Machine_done(super);
@@ -125,3 +139,37 @@ bool Machine_isCPUonline(const Machine* host, unsigned int id) {
 
    return true;
 }
+
+void Machine_scanGPUUsage(Machine* super) {
+   DarwinMachine* dhost = (DarwinMachine *)super;
+
+   if (!dhost->GPUService) {
+      return;
+   }
+
+   CFMutableDictionaryRef properties = NULL;
+   kern_return_t ret = IORegistryEntryCreateCFProperties(dhost->GPUService, &properties, kCFAllocatorDefault, kNilOptions);
+   if (ret != KERN_SUCCESS) {
+      return;
+   }
+
+   CFDictionaryRef perfStats = CFDictionaryGetValue(properties, CFSTR("PerformanceStatistics"));
+
+   if (!perfStats) {
+      goto cleanup;
+   }
+
+   assert(CFGetTypeID(perfStats) == CFDictionaryGetTypeID());
+
+   CFNumberRef deviceUtil = CFDictionaryGetValue(perfStats, CFSTR("Device Utilization %"));
+   if (!deviceUtil) {
+      goto cleanup;
+   }
+
+   int device = -1;
+   CFNumberGetValue(deviceUtil, kCFNumberIntType, &device);
+   super->totalGPUUsage = (double)device;
+
+cleanup:
+   CFRelease(properties);
+}

darwin/DarwinMachine.h

@@ -7,6 +7,7 @@ Released under the GNU GPLv2+, see the COPYING file
 in the source distribution for its full text.
 */
 
+#include <IOKit/IOKitLib.h>
 #include <mach/mach_host.h>
 #include <sys/sysctl.h>
 
@@ -26,6 +27,8 @@ typedef struct DarwinMachine_ {
    processor_cpu_load_info_t prev_load;
    processor_cpu_load_info_t curr_load;
 
+   io_service_t GPUService;
+
    ZfsArcStats zfs;
 } DarwinMachine;
 

darwin/Platform.c

@@ -38,6 +38,7 @@ in the source distribution for its full text.
 #include "DateMeter.h"
 #include "DateTimeMeter.h"
 #include "FileDescriptorMeter.h"
+#include "GPUMeter.h"
 #include "HostnameMeter.h"
 #include "LoadAverageMeter.h"
 #include "Macros.h"
@@ -144,6 +145,7 @@ const MeterClass* const Platform_meterTypes[] = {
    &DiskIOMeter_class,
    &NetworkIOMeter_class,
    &FileDescriptorMeter_class,
+   &GPUMeter_class,
    &BlankMeter_class,
    NULL
 };

dragonflybsd/DragonFlyBSDMachine.c

@@ -340,6 +340,7 @@ void Machine_scan(Machine* super) {
    DragonFlyBSDMachine_scanMemoryInfo(super);
    DragonFlyBSDMachine_scanCPUTime(super);
    DragonFlyBSDMachine_scanJails(this);
+   Machine_scanGPUUsage(super);
 }
 
 bool Machine_isCPUonline(const Machine* host, unsigned int id) {
@@ -349,3 +350,8 @@ bool Machine_isCPUonline(const Machine* host, unsigned int id) {
    // TODO: Support detecting online / offline CPUs.
    return true;
 }
+
+void Machine_scanGPUUsage(Machine* super) {
+   /* Not supported yet */
+   super->totalGPUUsage = -1.0;
+}

freebsd/FreeBSDMachine.c

@@ -387,6 +387,7 @@ void Machine_scan(Machine* super) {
    openzfs_sysctl_updateArcStats(&this->zfs);
    FreeBSDMachine_scanMemoryInfo(super);
    FreeBSDMachine_scanCPU(super);
+   Machine_scanGPUUsage(super);
 }
 
 bool Machine_isCPUonline(const Machine* host, unsigned int id) {
@@ -397,3 +398,8 @@ bool Machine_isCPUonline(const Machine* host, unsigned int id) {
 
    return true;
 }
+
+void Machine_scanGPUUsage(Machine* super) {
+   /* Not supported yet */
+   super->totalGPUUsage = -1.0;
+}

linux/LinuxMachine.c

@@ -42,6 +42,7 @@ in the source distribution for its full text.
 #define O_PATH         010000000 // declare for ancient glibc versions
 #endif
 
+
 /* Similar to get_nprocs_conf(3) / _SC_NPROCESSORS_CONF
  * https://sourceware.org/git/?p=glibc.git;a=blob;f=sysdeps/unix/sysv/linux/getsysstats.c;hb=HEAD
  */
@@ -732,6 +733,7 @@ void Machine_scan(Machine* super) {
    LinuxMachine_scanZfsArcstats(this);
    LinuxMachine_scanZramInfo(this);
    LinuxMachine_scanCPUTime(this);
+   Machine_scanGPUUsage(super);
 
    const Settings* settings = super->settings;
    if (settings->showCPUFrequency
@@ -820,3 +822,23 @@ bool Machine_isCPUonline(const Machine* super, unsigned int id) {
    assert(id < super->existingCPUs);
    return this->cpuData[id + 1].online;
 }
+
+void Machine_scanGPUUsage(Machine* super) {
+   LinuxMachine* this = (LinuxMachine*) super;
+
+   const uint64_t monotonictimeDelta = super->monotonicMs - super->prevMonotonicMs;
+
+   GPUEngineData *gpuEngineData;
+   size_t i;
+
+   super->totalGPUTimeDiff = saturatingSub(this->curGpuTime, this->prevGpuTime);
+
+   this->prevResidueTime = this->curResidueTime;
+   this->curResidueTime = this->curGpuTime;
+
+   for (gpuEngineData = this->gpuEngineData, i = 0; gpuEngineData; gpuEngineData = gpuEngineData->next, i++) {
+      this->curResidueTime = saturatingSub(this->curResidueTime, gpuEngineData->curTime);
+   }
+
+   super->totalGPUUsage = 100.0 * super->totalGPUTimeDiff / (1000 * 1000) / monotonictimeDelta;
+}

linux/LinuxMachine.h

@@ -89,6 +89,7 @@ typedef struct LinuxMachine_ {
    memory_t availableMem;
 
    unsigned long long int prevGpuTime, curGpuTime;  /* total absolute GPU time in nano seconds */
+   unsigned long long int prevResidueTime, curResidueTime;
    GPUEngineData* gpuEngineData;
 
    ZfsArcStats zfs;