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