xref: /xnu-10002.41.9/osfmk/kern/sched_hygiene.h (revision 699cd48037512bf4380799317ca44ca453c82f57) !
1 /*
2  * Copyright (c) 2021 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  * @OSF_COPYRIGHT@
30  *
31  */
32 
33 #include <stdbool.h>
34 #include <stdint.h>
35 
36 #ifndef KERN_SCHED_HYGIENE_DEBUG
37 #define KERN_SCHED_HYGIENE_DEBUG
38 
39 #if SCHED_HYGIENE_DEBUG
40 
41 #if !DEVELOPMENT && !DEBUG
42 #error SCHED_HYGIENE_DEBUG defined without DEVELOPMENT/DEBUG
43 #endif
44 
45 #include <mach/mach_types.h>
46 
47 #include <kern/startup.h>
48 
49 typedef enum sched_hygiene_mode {
50 	SCHED_HYGIENE_MODE_OFF = 0,
51 	SCHED_HYGIENE_MODE_TRACE = 1,
52 	SCHED_HYGIENE_MODE_PANIC = 2,
53 } sched_hygiene_mode_t;
54 
55 extern boolean_t sched_hygiene_debug_pmc;
56 
57 extern sched_hygiene_mode_t sched_preemption_disable_debug_mode;
58 
59 MACHINE_TIMEOUT_SPEC_DECL(sched_preemption_disable_threshold_mt);
60 extern machine_timeout_t sched_preemption_disable_threshold_mt;
61 
62 __attribute__((noinline)) void _prepare_preemption_disable_measurement(void);
63 __attribute__((noinline)) void _collect_preemption_disable_measurement(void);
64 
65 extern sched_hygiene_mode_t interrupt_masked_debug_mode;
66 
67 MACHINE_TIMEOUT_SPEC_DECL(interrupt_masked_timeout);
68 MACHINE_TIMEOUT_SPEC_DECL(stackshot_interrupt_masked_timeout);
69 
70 extern machine_timeout_t interrupt_masked_timeout;
71 extern machine_timeout_t stackshot_interrupt_masked_timeout;
72 
73 extern bool sched_hygiene_nonspec_tb;
74 
75 #define ml_get_sched_hygiene_timebase() (sched_hygiene_nonspec_tb ? ml_get_timebase() : ml_get_speculative_timebase())
76 
77 extern bool kprintf_spam_mt_pred(struct machine_timeout_spec const *spec);
78 
79 #endif /* SCHED_HYGIENE_DEBUG */
80 
81 #endif /* KERN_SCHED_HYGIENE_DEBUG */
82