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