xref: /xnu-10002.81.5/osfmk/arm/preemption_disable_internal.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1*5e3eaea3SApple OSS Distributions /*
2*5e3eaea3SApple OSS Distributions  * Copyright (c) 2020-2023 Apple Inc. All rights reserved.
3*5e3eaea3SApple OSS Distributions  *
4*5e3eaea3SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*5e3eaea3SApple OSS Distributions  *
6*5e3eaea3SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*5e3eaea3SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*5e3eaea3SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*5e3eaea3SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*5e3eaea3SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*5e3eaea3SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*5e3eaea3SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*5e3eaea3SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*5e3eaea3SApple OSS Distributions  *
15*5e3eaea3SApple OSS Distributions  * Please obtain a copy of the License at
16*5e3eaea3SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*5e3eaea3SApple OSS Distributions  *
18*5e3eaea3SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*5e3eaea3SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*5e3eaea3SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*5e3eaea3SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*5e3eaea3SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*5e3eaea3SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*5e3eaea3SApple OSS Distributions  * limitations under the License.
25*5e3eaea3SApple OSS Distributions  *
26*5e3eaea3SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*5e3eaea3SApple OSS Distributions  */
28*5e3eaea3SApple OSS Distributions 
29*5e3eaea3SApple OSS Distributions #include <kern/percpu.h>
30*5e3eaea3SApple OSS Distributions #include <stdatomic.h>
31*5e3eaea3SApple OSS Distributions #include <stdbool.h>
32*5e3eaea3SApple OSS Distributions #include <stdint.h>
33*5e3eaea3SApple OSS Distributions 
34*5e3eaea3SApple OSS Distributions #pragma once
35*5e3eaea3SApple OSS Distributions 
36*5e3eaea3SApple OSS Distributions 
37*5e3eaea3SApple OSS Distributions /**
38*5e3eaea3SApple OSS Distributions  * Track time and other counters during a preemption disabled window,
39*5e3eaea3SApple OSS Distributions  * when `SCHED_HYGIENE` is configured.
40*5e3eaea3SApple OSS Distributions  */
41*5e3eaea3SApple OSS Distributions struct _preemption_disable_pcpu {
42*5e3eaea3SApple OSS Distributions 	/**
43*5e3eaea3SApple OSS Distributions 	 * A snapshot of times and counters relevant to preemption disable measurement.
44*5e3eaea3SApple OSS Distributions 	 */
45*5e3eaea3SApple OSS Distributions 	struct _preemption_disable_snap {
46*5e3eaea3SApple OSS Distributions 		/* The time when preemption was disabled, in Mach time units. */
47*5e3eaea3SApple OSS Distributions 		uint64_t pds_mach_time;
48*5e3eaea3SApple OSS Distributions 		/* The amount of time spent in interrupts by the current CPU, in Mach time units. */
49*5e3eaea3SApple OSS Distributions 		uint64_t pds_int_mach_time;
50*5e3eaea3SApple OSS Distributions #if MONOTONIC
51*5e3eaea3SApple OSS Distributions 		/* The number of cycles elapsed on this CPU. */
52*5e3eaea3SApple OSS Distributions 		uint64_t pds_cycles;
53*5e3eaea3SApple OSS Distributions 		/* The number of instructions seen by this CPU. */
54*5e3eaea3SApple OSS Distributions 		uint64_t pds_instrs;
55*5e3eaea3SApple OSS Distributions #endif /* MONOTONIC */
56*5e3eaea3SApple OSS Distributions 	}
57*5e3eaea3SApple OSS Distributions 	/* At the start of the preemption disabled window. */
58*5e3eaea3SApple OSS Distributions 	pdp_start;
59*5e3eaea3SApple OSS Distributions 
60*5e3eaea3SApple OSS Distributions 	/* The maximum duration seen by this CPU, in Mach time units. */
61*5e3eaea3SApple OSS Distributions 	_Atomic uint64_t pdp_max_mach_duration;
62*5e3eaea3SApple OSS Distributions 	/*
63*5e3eaea3SApple OSS Distributions 	 * Whether to abandon the measurement on this CPU,
64*5e3eaea3SApple OSS Distributions 	 * due to a call to abandon_preemption_disable_measurement().
65*5e3eaea3SApple OSS Distributions 	 */
66*5e3eaea3SApple OSS Distributions 	bool pdp_abandon;
67*5e3eaea3SApple OSS Distributions };
68*5e3eaea3SApple OSS Distributions 
69*5e3eaea3SApple OSS Distributions PERCPU_DECL(struct _preemption_disable_pcpu, _preemption_disable_pcpu_data);
70