osfmk/kern/sched_urgency.h

   1 /*
   2  * Copyright (c) 2019 Apple 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 #ifndef _KERN_SCHED_URGENCY_H_
  30 #define _KERN_SCHED_URGENCY_H_
  31
  32 #ifdef MACH_KERNEL_PRIVATE
  33
  34 #include <kern/kern_types.h>
  35
  36 typedef enum thread_urgency {
  37         THREAD_URGENCY_NONE             = 0,    /* processor is idle */
  38         THREAD_URGENCY_BACKGROUND       = 1,    /* "background" thread (i.e. min-power) */
  39         THREAD_URGENCY_NORMAL           = 2,    /* "normal" thread */
  40         THREAD_URGENCY_REAL_TIME        = 3,    /* "real-time" or urgent thread */
  41         THREAD_URGENCY_LOWPRI           = 4,    /* low priority but not "background" hint for performance management subsystem */
  42         THREAD_URGENCY_MAX              = 5,    /* Max */
  43 } thread_urgency_t;
  44
  45 /* Returns the "urgency" of a thread (provided by scheduler) */
  46 extern thread_urgency_t      thread_get_urgency(
  47         thread_t        thread,
  48         uint64_t        *rt_period,
  49         uint64_t        *rt_deadline);
  50
  51 /* Tells the "urgency" of the just scheduled thread (provided by CPU PM) */
  52 extern void     thread_tell_urgency(
  53         thread_urgency_t             urgency,
  54         uint64_t        rt_period,
  55         uint64_t        rt_deadline,
  56         uint64_t        sched_latency,
  57         thread_t nthread);
  58
  59 #endif /* MACH_KERNEL_PRIVATE */
  60
  61 __END_DECLS
  62
  63 #endif /* _KERN_SCHED_URGENCY_H_ */