]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/kern/sched.h
xnu-1504.3.12.tar.gz
[apple/xnu.git] / osfmk / kern / sched.h
index 9c98bd1041086ae05afd9a47468e8fa092d424f3..9a153ea2921bf391b285b6a9e20f32e9e0987653 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_COPYRIGHT@
@@ -61,8 +67,6 @@
 #ifndef        _KERN_SCHED_H_
 #define _KERN_SCHED_H_
 
-#include <cpus.h>
-#include <simple_clock.h>
 #include <stat_time.h>
 
 #include <mach/policy.h>
 #include <kern/queue.h>
 #include <kern/lock.h>
 #include <kern/macro_help.h>
+#include <kern/timer_call.h>
+#include <kern/ast.h>
 
-#if    STAT_TIME
-
-/*
- *     Statistical timing uses microseconds as timer units.  16 bit shift
- *     yields priorities.  PRI_SHIFT_2 isn't needed.
- */
-#define PRI_SHIFT      (16 - SCHED_TICK_SHIFT)
-
-#else  /* STAT_TIME */
-
-/*
- *     Otherwise machine provides shift(s) based on time units it uses.
- */
-#include <machine/sched_param.h>
-
-#endif /* STAT_TIME */
-
-#define        NRQS            128                             /* 128 run queues per cpu */
-#define NRQBM          (NRQS / 32)             /* number of run queue bit maps */
+#define        NRQS            128                             /* 128 levels per run queue */
+#define NRQBM          (NRQS / 32)             /* number of words per bit map */
 
 #define MAXPRI         (NRQS-1)
 #define MINPRI         IDLEPRI                 /* lowest legal priority schedulable */
  *                             +
  *                             V
  * 80          Kernel mode only
- * 79          High priority
+ * 79          System high priority
  *                             A
  *                             +
  *                     (16 levels)
  *                             +
  *                             V
- * 64          High priority
+ * 64          System high priority
  * 63          Elevated priorities
  *                             A
  *                             +
  *************************************************************************
  */
 
+#define BASEPRI_RTQUEUES       (BASEPRI_REALTIME + 1)                          /* 97 */
 #define BASEPRI_REALTIME       (MAXPRI - (NRQS / 4) + 1)                       /* 96 */
 
-#define MAXPRI_STANDARD                (BASEPRI_REALTIME - 1)                          /* 95 */
-
-#define MAXPRI_KERNBAND                MAXPRI_STANDARD                                         /* 95 */
-#define MINPRI_KERNBAND                (MAXPRI_KERNBAND - (NRQS / 8) + 1)      /* 80 */
+#define MAXPRI_KERNEL          (BASEPRI_REALTIME - 1)                          /* 95 */
+#define BASEPRI_PREEMPT                (MAXPRI_KERNEL - 2)                                     /* 93 */
+#define BASEPRI_KERNEL         (MINPRI_KERNEL + 1)                                     /* 81 */
+#define MINPRI_KERNEL          (MAXPRI_KERNEL - (NRQS / 8) + 1)        /* 80 */
 
-#define MAXPRI_HIGHBAND                (MINPRI_KERNBAND - 1)                           /* 79 */
-#define MINPRI_HIGHBAND                (MAXPRI_HIGHBAND - (NRQS / 8) + 1)      /* 64 */
+#define MAXPRI_RESERVED                (MINPRI_KERNEL - 1)                                     /* 79 */
+#define MINPRI_RESERVED                (MAXPRI_RESERVED - (NRQS / 8) + 1)      /* 64 */
 
-#define MAXPRI_MAINBAND                (MINPRI_HIGHBAND - 1)                           /* 63 */
-#define BASEPRI_DEFAULT                (MAXPRI_MAINBAND - (NRQS / 4))          /* 31 */
-#define MINPRI_MAINBAND                MINPRI                                                          /*  0 */
-
-#define MINPRI_STANDARD                MINPRI_MAINBAND                                         /*  0 */
+#define MAXPRI_USER                    (MINPRI_RESERVED - 1)                           /* 63 */
+#define BASEPRI_CONTROL                (BASEPRI_DEFAULT + 17)                          /* 48 */
+#define BASEPRI_FOREGROUND     (BASEPRI_DEFAULT + 16)                          /* 47 */
+#define BASEPRI_BACKGROUND     (BASEPRI_DEFAULT + 15)                          /* 46 */
+#define BASEPRI_DEFAULT                (MAXPRI_USER - (NRQS / 4))                      /* 31 */
+#define MAXPRI_THROTTLE                (MINPRI + 4)                                            /*  4 */
+#define MINPRI_USER                    MINPRI                                                          /*  0 */
 
 /*
  *     Macro to check for invalid priorities.
 #define invalid_pri(pri) ((pri) < MINPRI || (pri) > MAXPRI)
 
 struct run_queue {
-       queue_head_t            queues[NRQS];           /* one for each priority */
-       decl_simple_lock_data(,lock)                    /* one lock for all queues */
-       int                                     bitmap[NRQBM];          /* run queue bitmap array */
        int                                     highq;                          /* highest runnable queue */
-       int                                     count;                          /* # of runnable threads */
+       int                                     bitmap[NRQBM];          /* run queue bitmap array */
+       int                                     count;                          /* # of threads total */
+       int                                     urgency;                        /* level of preemption urgency */
+       queue_head_t            queues[NRQS];           /* one for each priority */
 };
 
 typedef struct run_queue       *run_queue_t;
 #define RUN_QUEUE_NULL         ((run_queue_t) 0)
 
-#define csw_needed(thread, processor) (                                                                                \
-       ((thread)->state & TH_SUSP)                                                                             ||              \
-       ((processor)->first_quantum?                                                                                    \
-        ((processor)->runq.highq > (thread)->sched_pri                         ||                      \
-         (processor)->processor_set->runq.highq > (thread)->sched_pri) :               \
-        ((processor)->runq.highq >= (thread)->sched_pri                        ||                      \
-         (processor)->processor_set->runq.highq >= (thread)->sched_pri))       )
+#define first_timeslice(processor)             ((processor)->timeslice > 0)
+
+#define thread_quantum_init(thread)                                                    \
+MACRO_BEGIN                                                                                                    \
+       (thread)->current_quantum =                                                     \
+               ((thread)->sched_mode & TH_MODE_REALTIME)?                      \
+                       (thread)->realtime.computation: std_quantum;    \
+MACRO_END
+
+extern struct run_queue                rt_runq;
 
 /*
  *     Scheduler routines.
  */
 
 /* Remove thread from its run queue */
-extern run_queue_t     rem_runq(
-                                       thread_t        thread);
+extern boolean_t       run_queue_remove(
+                                               thread_t        thread);
 
-/* Mach factor computation (in mach_factor.c) */
-extern void            compute_mach_factor(void);
+/* Handle quantum expiration for an executing thread */
+extern void            thread_quantum_expire(
+                                       timer_call_param_t      processor,
+                                       timer_call_param_t      thread);
 
-/* Update threads quantum (in priority.c) */
-extern void            thread_quantum_update(
-                                       int                     mycpu,
-                                       thread_t        thread,
-                                       int                     nticks,
-                                       int                     state);
+/* Context switch check for current processor */
+extern ast_t   csw_check(processor_t           processor);
 
-extern int             min_quantum;    /* defines max context switch rate */
+extern uint32_t        std_quantum, min_std_quantum;
+extern uint32_t        std_quantum_us;
 
-/*
- *     Shift structures for holding update shifts.  Actual computation
- *     is  usage = (usage >> shift1) +/- (usage >> abs(shift2))  where the
- *     +/- is determined by the sign of shift 2.
- */
-struct shift {
-       int     shift1;
-       int     shift2;
-};
+extern uint32_t        max_rt_quantum, min_rt_quantum;
 
-typedef        struct shift    *shift_t, shift_data_t;
+extern uint32_t        sched_cswtime;
 
 /*
  *     Age usage (1 << SCHED_TICK_SHIFT) times per second.
  */
+#define SCHED_TICK_SHIFT       3
 
-extern unsigned        sched_tick;
+extern unsigned                sched_tick;
+extern uint32_t                sched_tick_interval;
 
-#define SCHED_TICK_SHIFT       3
+/* Periodic computation of various averages */
+extern void            compute_averages(void);
 
-#define SCHED_SCALE            128
-#define SCHED_SHIFT            7
+extern void            compute_averunnable(
+                                       void                    *nrun);
+
+extern void            compute_stack_target(
+                                       void                    *arg);
+
+extern void            compute_memory_pressure(
+                                       void                    *arg);
 
 /*
- *     thread_timer_delta macro takes care of both thread timers.
+ *     Conversion factor from usage
+ *     to priority.
  */
+extern uint32_t                sched_pri_shift;
+extern uint32_t                sched_fixed_shift;
+extern int8_t          sched_load_shifts[NRQS];
 
-#define thread_timer_delta(thread)                                             \
+extern int32_t         sched_poll_yield_shift;
+extern uint32_t                sched_safe_duration;
+
+extern uint32_t                sched_run_count, sched_share_count;
+extern uint32_t                sched_load_average, sched_mach_factor;
+
+extern uint32_t                avenrun[3], mach_factor[3];
+
+extern uint64_t                max_unsafe_computation;
+extern uint64_t                max_poll_computation;
+
+#define sched_run_incr()                       \
 MACRO_BEGIN                                                                                                    \
-       register unsigned       delta;                                                          \
-                                                                                                                       \
-       delta = 0;                                                                                              \
-       TIMER_DELTA((thread)->system_timer,                                             \
-                                       (thread)->system_timer_save, delta);    \
-       TIMER_DELTA((thread)->user_timer,                                               \
-                                       (thread)->user_timer_save, delta);              \
-       (thread)->cpu_delta += delta;                                                   \
-       (thread)->sched_delta += (delta *                                               \
-                                       (thread)->processor_set->sched_load);   \
+       machine_run_count(hw_atomic_add(&sched_run_count, 1));  \
+MACRO_END
+
+#define sched_run_decr()                       \
+MACRO_BEGIN                                                                                                    \
+       machine_run_count(hw_atomic_sub(&sched_run_count, 1));  \
+MACRO_END
+
+#define sched_share_incr()                     \
+MACRO_BEGIN                                                                                    \
+       (void)hw_atomic_add(&sched_share_count, 1);             \
+MACRO_END
+
+#define sched_share_decr()                     \
+MACRO_BEGIN                                                                                    \
+       (void)hw_atomic_sub(&sched_share_count, 1);             \
 MACRO_END
 
-#if    SIMPLE_CLOCK
 /*
- *     sched_usec is an exponential average of number of microseconds
- *     in a second for clock drift compensation.
+ *     thread_timer_delta macro takes care of both thread timers.
  */
-
-extern int     sched_usec;
-#endif /* SIMPLE_CLOCK */
+#define thread_timer_delta(thread, delta)                                      \
+MACRO_BEGIN                                                                                                    \
+       (delta) = (typeof(delta))timer_delta(&(thread)->system_timer,                   \
+                                                       &(thread)->system_timer_save);  \
+       (delta) += (typeof(delta))timer_delta(&(thread)->user_timer,                    \
+                                                       &(thread)->user_timer_save);    \
+MACRO_END
 
 #endif /* _KERN_SCHED_H_ */