xref: /xnu-10002.41.9/osfmk/kperf/pet.h (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions /*
2*699cd480SApple OSS Distributions  * Copyright (c) 2011-2018 Apple Computer, Inc. All rights reserved.
3*699cd480SApple OSS Distributions  *
4*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*699cd480SApple OSS Distributions  *
6*699cd480SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*699cd480SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*699cd480SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*699cd480SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*699cd480SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*699cd480SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*699cd480SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*699cd480SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*699cd480SApple OSS Distributions  *
15*699cd480SApple OSS Distributions  * Please obtain a copy of the License at
16*699cd480SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*699cd480SApple OSS Distributions  *
18*699cd480SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*699cd480SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*699cd480SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*699cd480SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*699cd480SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*699cd480SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*699cd480SApple OSS Distributions  * limitations under the License.
25*699cd480SApple OSS Distributions  *
26*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*699cd480SApple OSS Distributions  */
28*699cd480SApple OSS Distributions 
29*699cd480SApple OSS Distributions #include <kern/thread.h>
30*699cd480SApple OSS Distributions #include <stdbool.h>
31*699cd480SApple OSS Distributions 
32*699cd480SApple OSS Distributions #define KPERF_PET_DEFAULT_IDLE_RATE 15
33*699cd480SApple OSS Distributions 
34*699cd480SApple OSS Distributions extern bool kppet_lightweight_active;
35*699cd480SApple OSS Distributions extern _Atomic uint32_t kppet_gencount;
36*699cd480SApple OSS Distributions 
37*699cd480SApple OSS Distributions /*
38*699cd480SApple OSS Distributions  * If `actionid` is non-zero, set up PET to sample the action.  Otherwise,
39*699cd480SApple OSS Distributions  * disable PET.
40*699cd480SApple OSS Distributions  */
41*699cd480SApple OSS Distributions void kppet_config(unsigned int actionid);
42*699cd480SApple OSS Distributions 
43*699cd480SApple OSS Distributions /*
44*699cd480SApple OSS Distributions  * Reset PET back to its default settings.
45*699cd480SApple OSS Distributions  */
46*699cd480SApple OSS Distributions void kppet_reset(void);
47*699cd480SApple OSS Distributions 
48*699cd480SApple OSS Distributions /*
49*699cd480SApple OSS Distributions  * Notify PET that new threads are switching on-CPU.
50*699cd480SApple OSS Distributions  */
51*699cd480SApple OSS Distributions void kppet_on_cpu(thread_t thread, thread_continue_t continuation,
52*699cd480SApple OSS Distributions     uintptr_t *starting_frame);
53*699cd480SApple OSS Distributions 
54*699cd480SApple OSS Distributions /*
55*699cd480SApple OSS Distributions  * Wake the PET thread from its timer handler.
56*699cd480SApple OSS Distributions  */
57*699cd480SApple OSS Distributions void kppet_wake_thread(void);
58*699cd480SApple OSS Distributions 
59*699cd480SApple OSS Distributions /*
60*699cd480SApple OSS Distributions  * For configuring PET from the sysctl interface.
61*699cd480SApple OSS Distributions  */
62*699cd480SApple OSS Distributions int kppet_get_idle_rate(void);
63*699cd480SApple OSS Distributions int kppet_set_idle_rate(int new_idle_rate);
64*699cd480SApple OSS Distributions int kppet_get_lightweight_pet(void);
65*699cd480SApple OSS Distributions int kppet_set_lightweight_pet(int on);
66*699cd480SApple OSS Distributions 
67*699cd480SApple OSS Distributions /*
68*699cd480SApple OSS Distributions  * Update whether lightweight PET is active when turning sampling on and off.
69*699cd480SApple OSS Distributions  */
70*699cd480SApple OSS Distributions void kppet_lightweight_active_update(void);
71