1/*
2 * Copyright (c) 2011-2020 Apple Computer, 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 KPERF_SAMPLE_H
30#define KPERF_SAMPLE_H
31
32#include <kperf/thread_samplers.h>
33#include <kperf/task_samplers.h>
34#include "callstack.h"
35#include "kperf_kpc.h"
36#include "meminfo.h"
37
38/*
39 * Dispatch sampling may need to read from compressed, file-backed pages, which
40 * incurs a steep stack usage penalty.
41 */
42struct kperf_usample_min {
43 struct kperf_thread_dispatch th_dispatch;
44};
45
46/*
47 * For data that must be sampled in a fault-able context.
48 */
49struct kperf_usample {
50 struct kperf_usample_min *usample_min;
51 struct kp_ucallstack ucallstack;
52 struct kperf_thread_info th_info;
53};
54
55struct kperf_sample {
56 struct kperf_thread_info th_info;
57 struct kperf_thread_scheduling th_scheduling;
58 struct kperf_thread_snapshot th_snapshot;
59
60 struct kperf_task_snapshot tk_snapshot;
61
62 struct kp_kcallstack kcallstack;
63 struct meminfo meminfo;
64
65 struct kperf_usample usample;
66
67#if CONFIG_CPU_COUNTERS
68 struct kpcdata kpcdata;
69#endif /* CONFIG_CPU_COUNTERS */
70
71#if DEVELOPMENT || DEBUG
72 uint64_t sample_time;
73#endif /* DEVELOPMENT || DEBUG */
74};
75
76/* cache of threads on each CPU during a timer fire */
77extern uint64_t *kperf_tid_on_cpus;
78
79#endif /* !defined(KPERF_SAMPLE_H) */
80