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