Class IOReportFunctions

java.lang.Object

oshi.ffm.ForeignFunctions

oshi.ffm.mac.MacForeignFunctions

oshi.ffm.mac.IOReportFunctions

public final class IOReportFunctions
extends MacForeignFunctions

Bindings for the private IOReport framework (Apple Silicon GPU residency and energy counters).

IOReport is a private Apple framework. It may not be present on all systems. isAvailable() must be checked before calling any method; calling wrapper methods when isAvailable() returns false will result in a NullPointerException since the underlying handles are not initialized.

Field Summary

Fields inherited from class MacForeignFunctions

FRAMEWORK_SEARCH_PATHS

Fields inherited from class ForeignFunctions

CAPTURE_CALL_STATE, CAPTURED_STATE_LAYOUT, ERRNO_HANDLE, LIBRARY_ARENA, LINKER, NATIVE_LONG_SIZE, NATIVE_POINTER_SIZE, NATIVE_SIZE_T_SIZE, SYMBOL_LOOKUP

Method Summary

Modifier and Type	Method	Description
static MemorySegment	IOReportChannelGetChannelName(MemorySegment channel)
static MemorySegment	IOReportChannelGetGroup(MemorySegment channel)
static MemorySegment	IOReportChannelGetSubGroup(MemorySegment channel)
static MemorySegment	IOReportCopyChannelsInGroup(MemorySegment group, MemorySegment subgroup, long a, long b, long c)
static MemorySegment	IOReportCreateSamples(MemorySegment subscription, MemorySegment subscribedChannels, MemorySegment reserved)
static MemorySegment	IOReportCreateSamplesDelta(MemorySegment a, MemorySegment b, MemorySegment reserved)
static MemorySegment	IOReportCreateSubscription(MemorySegment a, MemorySegment channels, MemorySegment subscribedChannelsOut, long b, MemorySegment c)
static void	IOReportMergeChannels(MemorySegment a, MemorySegment b, MemorySegment null3)
static long	IOReportSimpleGetIntegerValue(MemorySegment channel, int reserved)
static int	IOReportStateGetCount(MemorySegment channel)
static MemorySegment	IOReportStateGetNameForIndex(MemorySegment channel, int index)
static long	IOReportStateGetResidency(MemorySegment channel, int index)
static boolean	isAvailable()	Returns true if the IOReport library was successfully loaded and all symbols resolved.

Methods inherited from class MacForeignFunctions

frameworkLookup

Methods inherited from class ForeignFunctions

downcall, getByteArrayFromNativePointer, getErrno, getStringFromNativePointer, getStructFromNativePointer, lib, libraryLookup

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

isAvailable

public static boolean isAvailable()

Returns true if the IOReport library was successfully loaded and all symbols resolved.

Returns:

whether IOReport is available on this system

IOReportCopyChannelsInGroup

public static MemorySegment IOReportCopyChannelsInGroup(MemorySegment group,
 MemorySegment subgroup,
 long a,
 long b,
 long c)
                                                 throws Throwable

Throws:

Throwable

IOReportMergeChannels

public static void IOReportMergeChannels(MemorySegment a,
 MemorySegment b,
 MemorySegment null3)
                                  throws Throwable

Throws:

Throwable

IOReportCreateSubscription

public static MemorySegment IOReportCreateSubscription(MemorySegment a,
 MemorySegment channels,
 MemorySegment subscribedChannelsOut,
 long b,
 MemorySegment c)
                                                throws Throwable

Throws:

Throwable

IOReportCreateSamples

public static MemorySegment IOReportCreateSamples(MemorySegment subscription,
 MemorySegment subscribedChannels,
 MemorySegment reserved)
                                           throws Throwable

Throws:

Throwable

IOReportCreateSamplesDelta

public static MemorySegment IOReportCreateSamplesDelta(MemorySegment a,
 MemorySegment b,
 MemorySegment reserved)
                                                throws Throwable

Throws:

Throwable

IOReportSimpleGetIntegerValue

public static long IOReportSimpleGetIntegerValue(MemorySegment channel,
 int reserved)
                                          throws Throwable

Throws:

Throwable

IOReportChannelGetGroup

public static MemorySegment IOReportChannelGetGroup(MemorySegment channel)
                                             throws Throwable

Throws:

Throwable

IOReportChannelGetSubGroup

public static MemorySegment IOReportChannelGetSubGroup(MemorySegment channel)
                                                throws Throwable

Throws:

Throwable

IOReportChannelGetChannelName

public static MemorySegment IOReportChannelGetChannelName(MemorySegment channel)
                                                   throws Throwable

Throws:

Throwable

IOReportStateGetCount

public static int IOReportStateGetCount(MemorySegment channel)
                                 throws Throwable

Throws:

Throwable

IOReportStateGetNameForIndex

public static MemorySegment IOReportStateGetNameForIndex(MemorySegment channel,
 int index)
                                                  throws Throwable

Throws:

Throwable

IOReportStateGetResidency

public static long IOReportStateGetResidency(MemorySegment channel,
 int index)
                                      throws Throwable

Throws:

Throwable