xref: /xnu-11417.140.69/osfmk/kperf/sample.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1*43a90889SApple OSS Distributions /*
2*43a90889SApple OSS Distributions  * Copyright (c) 2011-2020 Apple Computer, Inc. All rights reserved.
3*43a90889SApple OSS Distributions  *
4*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*43a90889SApple OSS Distributions  *
6*43a90889SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*43a90889SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*43a90889SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*43a90889SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*43a90889SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*43a90889SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*43a90889SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*43a90889SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*43a90889SApple OSS Distributions  *
15*43a90889SApple OSS Distributions  * Please obtain a copy of the License at
16*43a90889SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*43a90889SApple OSS Distributions  *
18*43a90889SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*43a90889SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*43a90889SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*43a90889SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*43a90889SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*43a90889SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*43a90889SApple OSS Distributions  * limitations under the License.
25*43a90889SApple OSS Distributions  *
26*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*43a90889SApple OSS Distributions  */
28*43a90889SApple OSS Distributions 
29*43a90889SApple OSS Distributions #ifndef KPERF_SAMPLE_H
30*43a90889SApple OSS Distributions #define KPERF_SAMPLE_H
31*43a90889SApple OSS Distributions 
32*43a90889SApple OSS Distributions #include <kperf/thread_samplers.h>
33*43a90889SApple OSS Distributions #include <kperf/task_samplers.h>
34*43a90889SApple OSS Distributions #include "callstack.h"
35*43a90889SApple OSS Distributions #include "kperf_kpc.h"
36*43a90889SApple OSS Distributions #include "meminfo.h"
37*43a90889SApple OSS Distributions 
38*43a90889SApple OSS Distributions /*
39*43a90889SApple OSS Distributions  * Dispatch sampling may need to read from compressed, file-backed pages, which
40*43a90889SApple OSS Distributions  * incurs a steep stack usage penalty.
41*43a90889SApple OSS Distributions  */
42*43a90889SApple OSS Distributions struct kperf_usample_min {
43*43a90889SApple OSS Distributions 	struct kperf_thread_dispatch th_dispatch;
44*43a90889SApple OSS Distributions };
45*43a90889SApple OSS Distributions 
46*43a90889SApple OSS Distributions /*
47*43a90889SApple OSS Distributions  * For data that must be sampled in a fault-able context.
48*43a90889SApple OSS Distributions  */
49*43a90889SApple OSS Distributions struct kperf_usample {
50*43a90889SApple OSS Distributions 	struct kperf_usample_min *usample_min;
51*43a90889SApple OSS Distributions 	struct kp_ucallstack ucallstack;
52*43a90889SApple OSS Distributions 	struct kperf_thread_info th_info;
53*43a90889SApple OSS Distributions };
54*43a90889SApple OSS Distributions 
55*43a90889SApple OSS Distributions struct kperf_sample {
56*43a90889SApple OSS Distributions 	struct kperf_thread_info       th_info;
57*43a90889SApple OSS Distributions 	struct kperf_thread_scheduling th_scheduling;
58*43a90889SApple OSS Distributions 	struct kperf_thread_snapshot   th_snapshot;
59*43a90889SApple OSS Distributions 
60*43a90889SApple OSS Distributions 	struct kperf_task_snapshot tk_snapshot;
61*43a90889SApple OSS Distributions 
62*43a90889SApple OSS Distributions 	struct kp_kcallstack kcallstack;
63*43a90889SApple OSS Distributions 	struct meminfo     meminfo;
64*43a90889SApple OSS Distributions 
65*43a90889SApple OSS Distributions 	struct kperf_usample usample;
66*43a90889SApple OSS Distributions 
67*43a90889SApple OSS Distributions #if CONFIG_CPU_COUNTERS
68*43a90889SApple OSS Distributions 	struct kpcdata    kpcdata;
69*43a90889SApple OSS Distributions #endif /* CONFIG_CPU_COUNTERS */
70*43a90889SApple OSS Distributions 
71*43a90889SApple OSS Distributions #if DEVELOPMENT || DEBUG
72*43a90889SApple OSS Distributions 	uint64_t sample_time;
73*43a90889SApple OSS Distributions #endif /* DEVELOPMENT || DEBUG */
74*43a90889SApple OSS Distributions };
75*43a90889SApple OSS Distributions 
76*43a90889SApple OSS Distributions /* cache of threads on each CPU during a timer fire */
77*43a90889SApple OSS Distributions extern uint64_t *kperf_tid_on_cpus;
78*43a90889SApple OSS Distributions 
79*43a90889SApple OSS Distributions #endif /* !defined(KPERF_SAMPLE_H) */
80