xref: /xnu-8796.101.5/osfmk/kern/telemetry.h (revision aca3beaa3dfbd42498b42c5e5ce20a938e6554e5)
1 /*
2  * Copyright (c) 2012-2013 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 #ifndef _KERNEL_TELEMETRY_H_
30 #define _KERNEL_TELEMETRY_H_
31 
32 #include <stdint.h>
33 #include <sys/cdefs.h>
34 #include <mach/mach_types.h>
35 #include <kern/thread.h>
36 
37 __BEGIN_DECLS
38 
39 #define TELEMETRY_CMD_TIMER_EVENT 1
40 #define TELEMETRY_CMD_VOUCHER_NAME 2
41 #define TELEMETRY_CMD_VOUCHER_STAIN TELEMETRY_CMD_VOUCHER_NAME
42 
43 enum telemetry_pmi {
44 	TELEMETRY_PMI_NONE,
45 	TELEMETRY_PMI_INSTRS,
46 	TELEMETRY_PMI_CYCLES,
47 };
48 #define TELEMETRY_CMD_PMI_SETUP 3
49 
50 #if XNU_KERNEL_PRIVATE
51 
52 /* boolean_t must be used since variable is loaded from assembly. */
53 extern volatile boolean_t telemetry_needs_record;
54 
55 extern void telemetry_init(void);
56 
57 extern void compute_telemetry(void *);
58 
59 extern void telemetry_ast(thread_t thread, uint32_t reasons);
60 
61 extern int telemetry_gather(user_addr_t buffer, uint32_t *length, bool mark);
62 
63 /* boolean_t must be used since this function is called from assembly. */
64 extern void telemetry_mark_curthread(boolean_t interrupted_userspace,
65     boolean_t pmi);
66 
67 extern void telemetry_task_ctl(task_t task, uint32_t reason, int enable_disable);
68 extern void telemetry_task_ctl_locked(task_t task, uint32_t reason, int enable_disable);
69 extern void telemetry_global_ctl(int enable_disable);
70 
71 extern int telemetry_timer_event(uint64_t deadline, uint64_t interval, uint64_t leeway);
72 extern int telemetry_pmi_setup(enum telemetry_pmi pmi_type, uint64_t interval);
73 
74 #if CONFIG_MACF
75 extern int telemetry_macf_mark_curthread(void);
76 #endif
77 
78 extern void bootprofile_init(void);
79 extern void bootprofile_wake_from_sleep(void);
80 extern void bootprofile_get(void **buffer, uint32_t *length);
81 extern int bootprofile_gather(user_addr_t buffer, uint32_t *length);
82 
83 #endif /* XNU_KERNEL_PRIVATE */
84 
85 __END_DECLS
86 
87 #endif /* _KERNEL_TELEMETRY_H_ */
88