xref: /xnu-10002.81.5/osfmk/machine/monotonic.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1 /*
2  * Copyright (c) 2017-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 #ifndef MACHINE_MONOTONIC_H
29 #define MACHINE_MONOTONIC_H
30 
31 #if defined(__x86_64__)
32 #include <x86_64/monotonic.h>
33 #elif defined(__arm64__)
34 #include <arm64/monotonic.h>
35 #else
36 #error unsupported architecture
37 #endif
38 
39 #include <stdatomic.h>
40 #include <stdbool.h>
41 #include <stdint.h>
42 
43 struct mt_cpu {
44 	uint64_t mtc_snaps[MT_CORE_NFIXED];
45 	uint64_t mtc_counts[MT_CORE_NFIXED];
46 	uint64_t mtc_counts_last[MT_CORE_NFIXED];
47 	uint64_t mtc_npmis;
48 	/*
49 	 * Whether this CPU should be using PMCs.
50 	 */
51 	bool mtc_active;
52 };
53 
54 struct mt_cpu *mt_cur_cpu(void);
55 
56 uint64_t mt_count_pmis(void);
57 void mt_mtc_update_fixed_counts(struct mt_cpu *mtc, uint64_t *counts,
58     uint64_t *counts_since);
59 uint64_t mt_mtc_update_count(struct mt_cpu *mtc, unsigned int ctr);
60 uint64_t mt_core_snap(unsigned int ctr);
61 void mt_core_set_snap(unsigned int ctr, uint64_t snap);
62 void mt_mtc_set_snap(struct mt_cpu *mtc, unsigned int ctr, uint64_t snap);
63 
64 typedef void (*mt_pmi_fn)(bool user_mode, void *ctx);
65 extern bool mt_microstackshots;
66 extern unsigned int mt_microstackshot_ctr;
67 extern mt_pmi_fn mt_microstackshot_pmi_handler;
68 extern void *mt_microstackshot_ctx;
69 extern uint64_t mt_core_reset_values[MT_CORE_NFIXED];
70 int mt_microstackshot_start_arch(uint64_t period);
71 
72 #endif /* !defined(MACHINE_MONOTONIC_H) */
73