xref: /xnu-10002.61.3/osfmk/kperf/thread_samplers.h (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1*0f4c859eSApple OSS Distributions /*
2*0f4c859eSApple OSS Distributions  * Copyright (c) 2011 Apple Computer, Inc. All rights reserved.
3*0f4c859eSApple OSS Distributions  *
4*0f4c859eSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*0f4c859eSApple OSS Distributions  *
6*0f4c859eSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*0f4c859eSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*0f4c859eSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*0f4c859eSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*0f4c859eSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*0f4c859eSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*0f4c859eSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*0f4c859eSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*0f4c859eSApple OSS Distributions  *
15*0f4c859eSApple OSS Distributions  * Please obtain a copy of the License at
16*0f4c859eSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*0f4c859eSApple OSS Distributions  *
18*0f4c859eSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*0f4c859eSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*0f4c859eSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*0f4c859eSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*0f4c859eSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*0f4c859eSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*0f4c859eSApple OSS Distributions  * limitations under the License.
25*0f4c859eSApple OSS Distributions  *
26*0f4c859eSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*0f4c859eSApple OSS Distributions  */
28*0f4c859eSApple OSS Distributions 
29*0f4c859eSApple OSS Distributions #ifndef KPERF_THREAD_SAMPLERS_H
30*0f4c859eSApple OSS Distributions #define KPERF_THREAD_SAMPLERS_H
31*0f4c859eSApple OSS Distributions 
32*0f4c859eSApple OSS Distributions #include <kperf/context.h>
33*0f4c859eSApple OSS Distributions 
34*0f4c859eSApple OSS Distributions /* legacy thread info */
35*0f4c859eSApple OSS Distributions struct kperf_thread_info {
36*0f4c859eSApple OSS Distributions 	uint64_t kpthi_pid;
37*0f4c859eSApple OSS Distributions 	uint64_t kpthi_tid;
38*0f4c859eSApple OSS Distributions 	uint64_t kpthi_dq_addr;
39*0f4c859eSApple OSS Distributions 	uint64_t kpthi_runmode;
40*0f4c859eSApple OSS Distributions };
41*0f4c859eSApple OSS Distributions 
42*0f4c859eSApple OSS Distributions void kperf_thread_info_sample(struct kperf_thread_info *,
43*0f4c859eSApple OSS Distributions     struct kperf_context *);
44*0f4c859eSApple OSS Distributions void kperf_thread_info_log(struct kperf_thread_info *);
45*0f4c859eSApple OSS Distributions 
46*0f4c859eSApple OSS Distributions // legacy names
47*0f4c859eSApple OSS Distributions #define kpthsc_requested_qos_ipc_override kpthsc_requested_qos_kevent_override
48*0f4c859eSApple OSS Distributions 
49*0f4c859eSApple OSS Distributions /* scheduling information */
50*0f4c859eSApple OSS Distributions struct kperf_thread_scheduling {
51*0f4c859eSApple OSS Distributions 	uint64_t kpthsc_user_time;
52*0f4c859eSApple OSS Distributions 	uint64_t kpthsc_system_time;
53*0f4c859eSApple OSS Distributions 	uint64_t kpthsc_runnable_time;
54*0f4c859eSApple OSS Distributions 	unsigned int kpthsc_state;
55*0f4c859eSApple OSS Distributions 	uint16_t kpthsc_base_priority;
56*0f4c859eSApple OSS Distributions 	uint16_t kpthsc_sched_priority;
57*0f4c859eSApple OSS Distributions 	unsigned int kpthsc_effective_qos :3,
58*0f4c859eSApple OSS Distributions 	    kpthsc_requested_qos :3,
59*0f4c859eSApple OSS Distributions 	    kpthsc_requested_qos_override :3,
60*0f4c859eSApple OSS Distributions 	    kpthsc_requested_qos_promote :3,
61*0f4c859eSApple OSS Distributions 	    kpthsc_requested_qos_kevent_override :3,
62*0f4c859eSApple OSS Distributions 	    kpthsc_requested_qos_sync_ipc_override :3,             /* obsolete */
63*0f4c859eSApple OSS Distributions 	    kpthsc_effective_latency_qos :3;
64*0f4c859eSApple OSS Distributions };
65*0f4c859eSApple OSS Distributions 
66*0f4c859eSApple OSS Distributions void kperf_thread_scheduling_sample(struct kperf_thread_scheduling *,
67*0f4c859eSApple OSS Distributions     struct kperf_context *);
68*0f4c859eSApple OSS Distributions void kperf_thread_scheduling_log(struct kperf_thread_scheduling *);
69*0f4c859eSApple OSS Distributions 
70*0f4c859eSApple OSS Distributions /* thread snapshot information */
71*0f4c859eSApple OSS Distributions struct kperf_thread_snapshot {
72*0f4c859eSApple OSS Distributions 	uint64_t kpthsn_last_made_runnable_time;
73*0f4c859eSApple OSS Distributions 	int16_t kpthsn_suspend_count;
74*0f4c859eSApple OSS Distributions 	uint8_t kpthsn_io_tier;
75*0f4c859eSApple OSS Distributions 	uint8_t kpthsn_flags;
76*0f4c859eSApple OSS Distributions };
77*0f4c859eSApple OSS Distributions 
78*0f4c859eSApple OSS Distributions void kperf_thread_snapshot_sample(struct kperf_thread_snapshot *,
79*0f4c859eSApple OSS Distributions     struct kperf_context *);
80*0f4c859eSApple OSS Distributions void kperf_thread_snapshot_log(struct kperf_thread_snapshot *);
81*0f4c859eSApple OSS Distributions 
82*0f4c859eSApple OSS Distributions /* libdispatch information */
83*0f4c859eSApple OSS Distributions struct kperf_thread_dispatch {
84*0f4c859eSApple OSS Distributions 	uint64_t kpthdi_dq_serialno;
85*0f4c859eSApple OSS Distributions 	char kpthdi_dq_label[64];
86*0f4c859eSApple OSS Distributions };
87*0f4c859eSApple OSS Distributions 
88*0f4c859eSApple OSS Distributions void kperf_thread_dispatch_sample(struct kperf_thread_dispatch *,
89*0f4c859eSApple OSS Distributions     struct kperf_context *);
90*0f4c859eSApple OSS Distributions int kperf_thread_dispatch_pend(struct kperf_context *, unsigned int actionid);
91*0f4c859eSApple OSS Distributions void kperf_thread_dispatch_log(struct kperf_thread_dispatch *);
92*0f4c859eSApple OSS Distributions 
93*0f4c859eSApple OSS Distributions void kperf_thread_inscyc_log(struct kperf_context *);
94*0f4c859eSApple OSS Distributions 
95*0f4c859eSApple OSS Distributions #endif /* !defined(KPERF_THREAD_SAMPLERS_H) */
96