1/*
2 * Copyright (c) 2012-2014 Apple Computer, Inc. All Rights Reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29// Internal data structures to be used by IOReporters and User Space Observers
30
31
32#ifndef _IOKERNELREPORTSTRUCTS_H_
33#define _IOKERNELREPORTSTRUCTS_H_
34
35#include <stdint.h>
36
37#if KERNEL
38#include <IOKit/IOReportTypes.h>
39#else
40#include <DriverKit/IOReportTypes.h>
41#endif
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
47// Drivers participating in IOReporting can advertise channels by
48// publishing properties in the I/O Kit registry. Various helper
49// mechanisms exist to produce correctly-formatted legends.
50// 12836893 tracks advertising channels in user space.
51#define kIOReportLegendPublicKey "IOReportLegendPublic" // bool
52#define kIOReportLegendKey "IOReportLegend" // arr
53#define kIOReportLegendChannelsKey "IOReportChannels" // arr
54#define kIOReportLegendGroupNameKey "IOReportGroupName" // str
55#define kIOReportLegendSubGroupNameKey "IOReportSubGroupName" // str
56#define kIOReportLegendInfoKey "IOReportChannelInfo" // dict
57#define kIOReportLegendUnitKey "IOReportChannelUnit" // num
58#define kIOReportLegendConfigKey "IOReportChannelConfig" // data
59#define kIOReportLegendStateNamesKey "IOReportChannelStateNames" // str[]
60
61// in an I/O Kit registry legend, a small "array struct" represents a channel
62#define kIOReportChannelIDIdx 0 // required
63#define kIOReportChannelTypeIdx 1 // required
64#define kIOReportChannelNameIdx 2 // optional
65
66/* Histogram Segment Configuration
67 * Currently supports 2 types of scaling to compute bucket upper bounds,
68 * linear or exponential.
69 * scale_flag = 0 -> linear scale
70 * 1 -> exponential scale
71 * upper_bound[n] = (scale_flag) ? pow(base,(n+1)) : base * (n+1);
72 */
73#define kIOHistogramScaleLinear 0
74#define kIOHistogramScaleExponential 1
75typedef struct {
76 uint32_t base_bucket_width;// segment[0].bucket[0] = [0, base_width]
77 uint32_t scale_flag; // bit 0 only in current use (see #defs)
78 uint32_t segment_idx; // for multiple segments histograms
79 uint32_t segment_bucket_count;// number of buckets in this segment
80} __attribute((packed)) IOHistogramSegmentConfig;
81
82// "normalized distribution"(FIXME?) internal format (unused?)
83typedef struct {
84 uint64_t samples;
85 uint64_t mean;
86 uint64_t variance;
87 uint64_t reserved;
88} __attribute((packed)) IONormDistReportValues;
89
90#ifdef __cplusplus
91}
92#endif
93
94#endif // _IOKERNELREPORTSTRUCTS_H_
95