osfmk/kern/sched.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie Mellon
  48  * the rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52 /*
  53  *      File:   sched.h
  54  *      Author: Avadis Tevanian, Jr.
  55  *      Date:   1985
  56  *
  57  *      Header file for scheduler.
  58  *
  59  */
  60
  61 #ifndef _KERN_SCHED_H_
  62 #define _KERN_SCHED_H_
  63
  64 #include <simple_clock.h>
  65 #include <stat_time.h>
  66
  67 #include <mach/policy.h>
  68 #include <kern/kern_types.h>
  69 #include <kern/queue.h>
  70 #include <kern/lock.h>
  71 #include <kern/macro_help.h>
  72 #include <kern/timer_call.h>
  73 #include <kern/ast.h>
  74
  75 #if     STAT_TIME
  76
  77 /*
  78  *      Statistical timing uses microseconds as timer units.
  79  */
  80 #define PRI_SHIFT       (16 - SCHED_TICK_SHIFT)
  81
  82 #else   /* STAT_TIME */
  83
  84 /*
  85  *      Otherwise machine provides shift(s) based on time units it uses.
  86  */
  87 #include <machine/sched_param.h>
  88
  89 #endif  /* STAT_TIME */
  90
  91 #define NRQS            128                             /* 128 levels per run queue */
  92 #define NRQBM           (NRQS / 32)             /* number of words per bit map */
  93
  94 #define MAXPRI          (NRQS-1)
  95 #define MINPRI          IDLEPRI                 /* lowest legal priority schedulable */
  96 #define IDLEPRI         0                               /* idle thread priority */
  97 #define DEPRESSPRI      MINPRI                  /* depress priority */
  98
  99 /*
 100  *      High-level priority assignments
 101  *
 102  *************************************************************************
 103  * 127          Reserved (real-time)
 104  *                              A
 105  *                              +
 106  *                      (32 levels)
 107  *                              +
 108  *                              V
 109  * 96           Reserved (real-time)
 110  * 95           Kernel mode only
 111  *                              A
 112  *                              +
 113  *                      (16 levels)
 114  *                              +
 115  *                              V
 116  * 80           Kernel mode only
 117  * 79           System high priority
 118  *                              A
 119  *                              +
 120  *                      (16 levels)
 121  *                              +
 122  *                              V
 123  * 64           System high priority
 124  * 63           Elevated priorities
 125  *                              A
 126  *                              +
 127  *                      (12 levels)
 128  *                              +
 129  *                              V
 130  * 52           Elevated priorities
 131  * 51           Elevated priorities (incl. BSD +nice)
 132  *                              A
 133  *                              +
 134  *                      (20 levels)
 135  *                              +
 136  *                              V
 137  * 32           Elevated priorities (incl. BSD +nice)
 138  * 31           Default (default base for threads)
 139  * 30           Lowered priorities (incl. BSD -nice)
 140  *                              A
 141  *                              +
 142  *                      (20 levels)
 143  *                              +
 144  *                              V
 145  * 11           Lowered priorities (incl. BSD -nice)
 146  * 10           Lowered priorities (aged pri's)
 147  *                              A
 148  *                              +
 149  *                      (11 levels)
 150  *                              +
 151  *                              V
 152  * 0            Lowered priorities (aged pri's / idle)
 153  *************************************************************************
 154  */
 155
 156 #define BASEPRI_RTQUEUES        (BASEPRI_REALTIME + 1)                          /* 97 */
 157 #define BASEPRI_REALTIME        (MAXPRI - (NRQS / 4) + 1)                       /* 96 */
 158
 159 #define MAXPRI_STANDARD         (BASEPRI_REALTIME - 1)                          /* 95 */
 160
 161 #define MAXPRI_KERNEL           MAXPRI_STANDARD                                         /* 95 */
 162 #define BASEPRI_PREEMPT         (MAXPRI_KERNEL - 2)                                     /* 93 */
 163 #define BASEPRI_KERNEL          (MINPRI_KERNEL + 1)                                     /* 81 */
 164 #define MINPRI_KERNEL           (MAXPRI_KERNEL - (NRQS / 8) + 1)        /* 80 */
 165
 166 #define MAXPRI_SYSTEM           (MINPRI_KERNEL - 1)                                     /* 79 */
 167 #define MINPRI_SYSTEM           (MAXPRI_SYSTEM - (NRQS / 8) + 1)        /* 64 */
 168
 169 #define MAXPRI_USER                     (MINPRI_SYSTEM - 1)                                     /* 63 */
 170 #define BASEPRI_CONTROL         (BASEPRI_DEFAULT + 17)                          /* 48 */
 171 #define BASEPRI_FOREGROUND      (BASEPRI_DEFAULT + 16)                          /* 47 */
 172 #define BASEPRI_BACKGROUND      (BASEPRI_DEFAULT + 15)                          /* 46 */
 173 #define BASEPRI_DEFAULT         (MAXPRI_USER - (NRQS / 4))                      /* 31 */
 174 #define MINPRI_USER                     MINPRI                                                          /*  0 */
 175
 176 #define MINPRI_STANDARD         MINPRI_USER                                                     /*  0 */
 177
 178 /*
 179  *      Macro to check for invalid priorities.
 180  */
 181 #define invalid_pri(pri) ((pri) < MINPRI || (pri) > MAXPRI)
 182
 183 struct run_queue {
 184         int                                     highq;                          /* highest runnable queue */
 185         int                                     bitmap[NRQBM];          /* run queue bitmap array */
 186         int                                     count;                          /* # of threads total */
 187         int                                     urgency;                        /* level of preemption urgency */
 188         queue_head_t            queues[NRQS];           /* one for each priority */
 189 };
 190
 191 typedef struct run_queue        *run_queue_t;
 192 #define RUN_QUEUE_NULL          ((run_queue_t) 0)
 193
 194 #define first_timeslice(processor)              ((processor)->timeslice > 0)
 195
 196 #define processor_timeslice_setup(processor, thread)                    \
 197 MACRO_BEGIN                                                                                                             \
 198         (processor)->timeslice =                                                                        \
 199                 ((thread)->sched_mode & TH_MODE_TIMESHARE)?                             \
 200                         (processor)->processor_set->timeshare_quanta: 1;        \
 201 MACRO_END
 202
 203 #define thread_quantum_init(thread)                                                     \
 204 MACRO_BEGIN                                                                                                     \
 205         (thread)->current_quantum =                                                     \
 206                 ((thread)->sched_mode & TH_MODE_REALTIME)?                      \
 207                         (thread)->realtime.computation: std_quantum;    \
 208 MACRO_END
 209
 210 /* Invoked at splsched by a thread on itself */
 211 #define csw_needed(thread, processor) (                                                                         \
 212         ((thread)->state & TH_SUSP)                                                                             ||              \
 213         (first_timeslice(processor)?                                                                                    \
 214          ((processor)->runq.highq > (thread)->sched_pri                         ||                      \
 215           (processor)->processor_set->runq.highq > (thread)->sched_pri) :               \
 216          ((processor)->runq.highq >= (thread)->sched_pri                        ||                      \
 217           (processor)->processor_set->runq.highq >= (thread)->sched_pri))       )
 218
 219 /*
 220  *      Scheduler routines.
 221  */
 222
 223 /* Remove thread from its run queue */
 224 extern run_queue_t      run_queue_remove(
 225                                                 thread_t        thread);
 226
 227 /* Periodic computation of load factors */
 228 extern void             compute_mach_factor(void);
 229
 230 /* Handle quantum expiration for an executing thread */
 231 extern void             thread_quantum_expire(
 232                                         timer_call_param_t      processor,
 233                                         timer_call_param_t      thread);
 234
 235 /* Called at splsched by a thread on itself */
 236 extern ast_t    csw_check(
 237                                         thread_t                thread,
 238                                         processor_t             processor);
 239
 240 extern uint32_t std_quantum, min_std_quantum;
 241 extern uint32_t std_quantum_us;
 242
 243 extern uint32_t max_rt_quantum, min_rt_quantum;
 244
 245 /*
 246  *      Shift structures for holding update shifts.  Actual computation
 247  *      is  usage = (usage >> shift1) +/- (usage >> abs(shift2))  where the
 248  *      +/- is determined by the sign of shift 2.
 249  */
 250 struct shift {
 251         int     shift1;
 252         int     shift2;
 253 };
 254
 255 typedef struct shift    *shift_t, shift_data_t;
 256
 257 /*
 258  *      Age usage (1 << SCHED_TICK_SHIFT) times per second.
 259  */
 260
 261 extern unsigned sched_tick;
 262
 263 #define SCHED_TICK_SHIFT        3
 264
 265 #define SCHED_SCALE             128
 266 #define SCHED_SHIFT             7
 267
 268 /*
 269  *      thread_timer_delta macro takes care of both thread timers.
 270  */
 271 #define thread_timer_delta(thread)                                              \
 272 MACRO_BEGIN                                                                                                     \
 273         register uint32_t       delta;                                                          \
 274                                                                                                                         \
 275         delta = 0;                                                                                              \
 276         TIMER_DELTA((thread)->system_timer,                                             \
 277                                         (thread)->system_timer_save, delta);    \
 278         TIMER_DELTA((thread)->user_timer,                                               \
 279                                         (thread)->user_timer_save, delta);              \
 280         (thread)->cpu_delta += delta;                                                   \
 281         (thread)->sched_delta += (delta *                                               \
 282                                         (thread)->processor_set->sched_load);   \
 283 MACRO_END
 284
 285 #if     SIMPLE_CLOCK
 286 /*
 287  *      sched_usec is an exponential average of number of microseconds
 288  *      in a second for clock drift compensation.
 289  */
 290
 291 extern int      sched_usec;
 292 #endif  /* SIMPLE_CLOCK */
 293
 294 #endif  /* _KERN_SCHED_H_ */