Interface IOReport

All Superinterfaces:

Library

public interface IOReport
extends Library

IOReport is a private Apple framework that provides access to hardware performance counters, including GPU residency and energy metrics on Apple Silicon.

These are non-public APIs. Mappings are provided for OSHI internal use only and should not be considered stable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IOReport.IOReportSubscriptionRef	Opaque handle returned by IOReportCreateSubscription(Pointer, CoreFoundation.CFDictionaryRef, PointerByReference, long, CoreFoundation.CFTypeRef).

Nested classes/interfaces inherited from interface Library

Library.Handler

Field Summary

Fields

Modifier and Type	Field	Description
static final IOReport	INSTANCE

Fields inherited from interface Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method	Description
CoreFoundation.CFStringRef	IOReportChannelGetChannelName(CoreFoundation.CFDictionaryRef channel)	Returns the channel name of a channel entry.
CoreFoundation.CFStringRef	IOReportChannelGetGroup(CoreFoundation.CFDictionaryRef channel)	Returns the group name of a channel entry.
CoreFoundation.CFStringRef	IOReportChannelGetSubGroup(CoreFoundation.CFDictionaryRef channel)	Returns the subgroup name of a channel entry.
CoreFoundation.CFDictionaryRef	IOReportCopyChannelsInGroup(CoreFoundation.CFStringRef group, CoreFoundation.CFStringRef subgroup, long a, long b, long c)	Returns a mutable dictionary describing all channels in the given group (and optional subgroup).
CoreFoundation.CFDictionaryRef	IOReportCreateSamples(IOReport.IOReportSubscriptionRef subscription, CoreFoundation.CFDictionaryRef subscribedChannels, CoreFoundation.CFTypeRef reserved)	Takes a sample of all subscribed channels.
CoreFoundation.CFDictionaryRef	IOReportCreateSamplesDelta(CoreFoundation.CFDictionaryRef a, CoreFoundation.CFDictionaryRef b, CoreFoundation.CFTypeRef reserved)	Computes the delta between two samples taken from the same subscription.
IOReport.IOReportSubscriptionRef	IOReportCreateSubscription(Pointer a, CoreFoundation.CFDictionaryRef channels, PointerByReference subscribedChannels, long b, CoreFoundation.CFTypeRef c)	Creates a subscription for the channels described by channels.
void	IOReportMergeChannels(CoreFoundation.CFDictionaryRef a, CoreFoundation.CFDictionaryRef b, CoreFoundation.CFTypeRef null3)	Merges the channel descriptors from b into a in place.
long	IOReportSimpleGetIntegerValue(CoreFoundation.CFDictionaryRef channel, int reserved)	Extracts the integer value from a single channel entry in a sample or delta dictionary.
int	IOReportStateGetCount(CoreFoundation.CFDictionaryRef channel)	Returns the number of states in a channel entry.
CoreFoundation.CFStringRef	IOReportStateGetNameForIndex(CoreFoundation.CFDictionaryRef channel, int index)	Returns the name of the state at the given index.
long	IOReportStateGetResidency(CoreFoundation.CFDictionaryRef channel, int index)	Returns the residency tick count for the state at the given index.

Field Details

INSTANCE

static final IOReport INSTANCE

Method Details

IOReportCopyChannelsInGroup

CoreFoundation.CFDictionaryRef IOReportCopyChannelsInGroup(CoreFoundation.CFStringRef group,
 CoreFoundation.CFStringRef subgroup,
 long a,
 long b,
 long c)

Returns a mutable dictionary describing all channels in the given group (and optional subgroup).

Parameters:

group - channel group name (e.g. "GPU Stats")

subgroup - subgroup name, or null for all subgroups

a - reserved, pass 0

b - reserved, pass 0

c - reserved, pass 0

Returns:

a CFDictionaryRef channel descriptor (caller must release), or null on failure

IOReportMergeChannels

void IOReportMergeChannels(CoreFoundation.CFDictionaryRef a,
 CoreFoundation.CFDictionaryRef b,
 CoreFoundation.CFTypeRef null3)

Merges the channel descriptors from b into a in place.

Parameters:

a - destination channel descriptor (mutable)

b - source channel descriptor

null3 - reserved, pass null

IOReportCreateSubscription

IOReport.IOReportSubscriptionRef IOReportCreateSubscription(Pointer a,
 CoreFoundation.CFDictionaryRef channels,
 PointerByReference subscribedChannels,
 long b,
 CoreFoundation.CFTypeRef c)

Creates a subscription for the channels described by channels. The framework writes the actually subscribed channel descriptor into subscribedChannels; callers must use that value (not the original channels) when calling IOReportCreateSamples(IOReport.IOReportSubscriptionRef, CoreFoundation.CFDictionaryRef, CoreFoundation.CFTypeRef).

Parameters:

a - reserved, pass null

channels - channel descriptor from IOReportCopyChannelsInGroup(CoreFoundation.CFStringRef, CoreFoundation.CFStringRef, long, long, long)

subscribedChannels - receives the subscribed channel descriptor (caller must release)

b - reserved, pass 0

c - reserved, pass null

Returns:

subscription handle (caller must release), or null on failure

IOReportCreateSamples

CoreFoundation.CFDictionaryRef IOReportCreateSamples(IOReport.IOReportSubscriptionRef subscription,
 CoreFoundation.CFDictionaryRef subscribedChannels,
 CoreFoundation.CFTypeRef reserved)

Takes a sample of all subscribed channels.

Parameters:

subscription - the subscription handle

subscribedChannels - the subscribed channel descriptor from IOReportCreateSubscription(Pointer, CoreFoundation.CFDictionaryRef, PointerByReference, long, CoreFoundation.CFTypeRef)

reserved - reserved, pass null

Returns:

a CFDictionaryRef sample (caller must release), or null on failure

IOReportCreateSamplesDelta

CoreFoundation.CFDictionaryRef IOReportCreateSamplesDelta(CoreFoundation.CFDictionaryRef a,
 CoreFoundation.CFDictionaryRef b,
 CoreFoundation.CFTypeRef reserved)

Computes the delta between two samples taken from the same subscription.

Parameters:

a - earlier sample

b - later sample

reserved - reserved, pass null

Returns:

a CFDictionaryRef delta (caller must release), or null on failure

IOReportSimpleGetIntegerValue

long IOReportSimpleGetIntegerValue(CoreFoundation.CFDictionaryRef channel,
 int reserved)

Extracts the integer value from a single channel entry in a sample or delta dictionary.

Parameters:

channel - a channel entry dictionary

reserved - reserved, pass 0

Returns:

the channel's integer value

IOReportChannelGetGroup

CoreFoundation.CFStringRef IOReportChannelGetGroup(CoreFoundation.CFDictionaryRef channel)

Returns the group name of a channel entry.

Parameters:

channel - a channel entry dictionary

Returns:

the group name as a CFStringRef

IOReportChannelGetSubGroup

CoreFoundation.CFStringRef IOReportChannelGetSubGroup(CoreFoundation.CFDictionaryRef channel)

Returns the subgroup name of a channel entry.

Parameters:

channel - a channel entry dictionary

Returns:

the subgroup name as a CFStringRef

IOReportChannelGetChannelName

CoreFoundation.CFStringRef IOReportChannelGetChannelName(CoreFoundation.CFDictionaryRef channel)

Returns the channel name of a channel entry.

Parameters:

channel - a channel entry dictionary

Returns:

the channel name as a CFStringRef

IOReportStateGetCount

int IOReportStateGetCount(CoreFoundation.CFDictionaryRef channel)

Returns the number of states in a channel entry.

Parameters:

channel - a channel entry dictionary

Returns:

the number of states

IOReportStateGetNameForIndex

CoreFoundation.CFStringRef IOReportStateGetNameForIndex(CoreFoundation.CFDictionaryRef channel,
 int index)

Returns the name of the state at the given index.

Parameters:

channel - a channel entry dictionary

index - zero-based state index

Returns:

the state name as a CFStringRef

IOReportStateGetResidency

long IOReportStateGetResidency(CoreFoundation.CFDictionaryRef channel,
 int index)

Returns the residency tick count for the state at the given index.

Parameters:

channel - a channel entry dictionary

index - zero-based state index

Returns:

residency ticks