xref: /xnu-8020.140.41/osfmk/kperf/task_samplers.h (revision 27b03b360a988dfd3dfdf34262bb0042026747cc)
1*27b03b36SApple OSS Distributions /*
2*27b03b36SApple OSS Distributions  * Copyright (c) 2016 Apple Computer, Inc. All rights reserved.
3*27b03b36SApple OSS Distributions  *
4*27b03b36SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*27b03b36SApple OSS Distributions  *
6*27b03b36SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*27b03b36SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*27b03b36SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*27b03b36SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*27b03b36SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*27b03b36SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*27b03b36SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*27b03b36SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*27b03b36SApple OSS Distributions  *
15*27b03b36SApple OSS Distributions  * Please obtain a copy of the License at
16*27b03b36SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*27b03b36SApple OSS Distributions  *
18*27b03b36SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*27b03b36SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*27b03b36SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*27b03b36SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*27b03b36SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*27b03b36SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*27b03b36SApple OSS Distributions  * limitations under the License.
25*27b03b36SApple OSS Distributions  *
26*27b03b36SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*27b03b36SApple OSS Distributions  */
28*27b03b36SApple OSS Distributions 
29*27b03b36SApple OSS Distributions #ifndef KPERF_TASK_SAMPLERS_H
30*27b03b36SApple OSS Distributions #define KPERF_TASK_SAMPLERS_H
31*27b03b36SApple OSS Distributions 
32*27b03b36SApple OSS Distributions #include <kperf/context.h>
33*27b03b36SApple OSS Distributions #include <kern/task.h>
34*27b03b36SApple OSS Distributions 
35*27b03b36SApple OSS Distributions struct kperf_task_snapshot {
36*27b03b36SApple OSS Distributions 	uint64_t kptksn_flags;
37*27b03b36SApple OSS Distributions 	uint64_t kptksn_user_time_in_terminated_threads;
38*27b03b36SApple OSS Distributions 	uint64_t kptksn_system_time_in_terminated_threads;
39*27b03b36SApple OSS Distributions 	int kptksn_suspend_count;
40*27b03b36SApple OSS Distributions 	int kptksn_pageins;
41*27b03b36SApple OSS Distributions };
42*27b03b36SApple OSS Distributions 
43*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_DARWIN_BG               (1U << 0)
44*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_FOREGROUND              (1U << 1)
45*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_BOOSTED                 (1U << 2)
46*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_DIRTY                   (1U << 3)
47*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_WQ_FLAGS_VALID          (1U << 4)
48*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_WQ_EXCEEDED_TOTAL       (1U << 5)
49*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_WQ_EXCEEDED_CONSTRAINED (1U << 6)
50*27b03b36SApple OSS Distributions #define KPERF_TASK_FLAG_DIRTY_TRACKED           (1U << 7)
51*27b03b36SApple OSS Distributions #define KPERF_TASK_ALLOW_IDLE_EXIT              (1U << 8)
52*27b03b36SApple OSS Distributions 
53*27b03b36SApple OSS Distributions void kperf_task_snapshot_sample(task_t task, struct kperf_task_snapshot *tksn);
54*27b03b36SApple OSS Distributions void kperf_task_snapshot_log(struct kperf_task_snapshot *tksn);
55*27b03b36SApple OSS Distributions void kperf_task_info_log(struct kperf_context *ctx);
56*27b03b36SApple OSS Distributions 
57*27b03b36SApple OSS Distributions #endif /* !defined(KPERF_TASK_SAMPLERS_H) */
58