1/*
2 * Copyright (c) 2020-2023 Apple 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#include <kern/percpu.h>
30#include <stdatomic.h>
31#include <stdbool.h>
32#include <stdint.h>
33
34#pragma once
35
36#if CONFIG_SPTM
37/*
38 * This header is only meant for the PPL and SPTM to access the preemption disable data structure directly.
39 */
40#endif /* CONFIG_SPTM */
41
42/**
43 * Track time and other counters during a preemption disabled window,
44 * when `SCHED_HYGIENE` is configured.
45 */
46struct _preemption_disable_pcpu {
47 /**
48 * A snapshot of times and counters relevant to preemption disable measurement.
49 */
50 struct _preemption_disable_snap {
51 /* The time when preemption was disabled, in Mach time units. */
52 uint64_t pds_mach_time;
53 /* The amount of time spent in interrupts by the current CPU, in Mach time units. */
54 uint64_t pds_int_mach_time;
55#if CONFIG_CPU_COUNTERS
56 /* The number of cycles elapsed on this CPU. */
57 uint64_t pds_cycles;
58 /* The number of instructions seen by this CPU. */
59 uint64_t pds_instrs;
60#endif /* CONFIG_CPU_COUNTERS */
61 }
62 /* At the start of the preemption disabled window. */
63 pdp_start;
64
65 /* The maximum duration seen by this CPU, in Mach time units. */
66 _Atomic uint64_t pdp_max_mach_duration;
67 /*
68 * Whether to abandon the measurement on this CPU,
69 * due to a call to abandon_preemption_disable_measurement().
70 */
71 bool pdp_abandon;
72};
73
74PERCPU_DECL(struct _preemption_disable_pcpu, _preemption_disable_pcpu_data);
75