osfmk/kperf/pet.h

   1 /*
   2  * Copyright (c) 2011 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #include <kern/thread.h>
  30
  31 #define KPERF_PET_DEFAULT_IDLE_RATE (15)
  32
  33 extern boolean_t kperf_lightweight_pet_active;
  34 extern uint32_t kperf_pet_gen;
  35
  36 /* prepare PET to be able to fire action with given ID, or disable PET */
  37 void kperf_pet_config(unsigned int action_id);
  38
  39 /* fire off a PET sample, both before and after on-core samples */
  40 void kperf_pet_fire_before(void);
  41 void kperf_pet_fire_after(void);
  42
  43 /* notify PET of new threads switching on */
  44 void kperf_pet_on_cpu(thread_t thread, thread_continue_t continuation,
  45                       uintptr_t *starting_frame);
  46
  47 /* get/set rate at which idle threads are sampled by PET */
  48 int kperf_get_pet_idle_rate(void);
  49 int kperf_set_pet_idle_rate(int val);
  50
  51 /* get/set whether lightweight PET is enabled */
  52 int kperf_get_lightweight_pet(void);
  53 int kperf_set_lightweight_pet(int val);
  54
  55 void kperf_lightweight_pet_active_update(void);