osfmk/kern/sched_prim.h

   1 /*
   2  * Copyright (c) 2000-2008 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  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   sched_prim.h
  60  *      Author: David Golub
  61  *
  62  *      Scheduling primitive definitions file
  63  *
  64  */
  65
  66 #ifndef _KERN_SCHED_PRIM_H_
  67 #define _KERN_SCHED_PRIM_H_
  68
  69 #include <mach/boolean.h>
  70 #include <mach/machine/vm_types.h>
  71 #include <mach/kern_return.h>
  72 #include <kern/clock.h>
  73 #include <kern/kern_types.h>
  74 #include <kern/thread.h>
  75 #include <sys/cdefs.h>
  76
  77 #ifdef  MACH_KERNEL_PRIVATE
  78
  79 /* Initialization */
  80 extern void             sched_init(void) __attribute__((section("__TEXT, initcode")));
  81
  82 extern void             sched_startup(void);
  83
  84 extern void             sched_timebase_init(void);
  85
  86 /* Force a preemption point for a thread and wait for it to stop running */
  87 extern boolean_t        thread_stop(
  88                                                 thread_t        thread);
  89
  90 /* Release a previous stop request */
  91 extern void                     thread_unstop(
  92                                                 thread_t        thread);
  93
  94 /* Wait for a thread to stop running */
  95 extern void                     thread_wait(
  96                                                 thread_t        thread);
  97
  98 /* Unblock thread on wake up */
  99 extern boolean_t        thread_unblock(
 100                                                 thread_t                thread,
 101                                                 wait_result_t   wresult);
 102
 103 /* Unblock and dispatch thread */
 104 extern kern_return_t    thread_go(
 105                                                         thread_t                thread,
 106                                                         wait_result_t   wresult);
 107
 108 /* Handle threads at context switch */
 109 extern void                     thread_dispatch(
 110                                                 thread_t                old_thread,
 111                                                 thread_t                new_thread);
 112
 113 /* Switch directly to a particular thread */
 114 extern int                      thread_run(
 115                                                 thread_t                        self,
 116                                                 thread_continue_t       continuation,
 117                                                 void                            *parameter,
 118                                                 thread_t                        new_thread);
 119
 120 /* Resume thread with new stack */
 121 extern void                     thread_continue(
 122                                                 thread_t                old_thread);
 123
 124 /* Invoke continuation */
 125 extern void             call_continuation(
 126                                         thread_continue_t       continuation,
 127                                         void                            *parameter,
 128                                         wait_result_t           wresult);
 129
 130 /* Set the current scheduled priority */
 131 extern void             set_sched_pri(
 132                                         thread_t                thread,
 133                                         int                             priority);
 134
 135 /* Set base priority of the specified thread */
 136 extern void             set_priority(
 137                                         thread_t                thread,
 138                                         int                             priority);
 139
 140 /* Reset scheduled priority of thread */
 141 extern void             compute_priority(
 142                                         thread_t                thread,
 143                                         boolean_t               override_depress);
 144
 145 /* Adjust scheduled priority of thread during execution */
 146 extern void             compute_my_priority(
 147                                         thread_t                thread);
 148
 149 /* Periodic scheduler activity */
 150 extern void             sched_tick_thread(void);
 151
 152 /* Perform sched_tick housekeeping activities */
 153 extern void             update_priority(
 154                                         thread_t                thread);
 155
 156 /* Idle processor thread */
 157 extern void             idle_thread(void);
 158
 159 extern kern_return_t    idle_thread_create(
 160                                                         processor_t             processor);
 161
 162 /* Continuation return from syscall */
 163 extern void     thread_syscall_return(
 164                         kern_return_t   ret);
 165
 166 /* Context switch */
 167 extern wait_result_t    thread_block_reason(
 168                                                         thread_continue_t       continuation,
 169                                                         void                            *parameter,
 170                                                         ast_t                           reason);
 171
 172 /* Reschedule thread for execution */
 173 extern void             thread_setrun(
 174                                         thread_t        thread,
 175                                         integer_t       options);
 176
 177 #define SCHED_TAILQ             1
 178 #define SCHED_HEADQ             2
 179 #define SCHED_PREEMPT   4
 180
 181 extern processor_set_t  task_choose_pset(
 182                                                         task_t                  task);
 183
 184 /* Bind the current thread to a particular processor */
 185 extern processor_t              thread_bind(
 186                                                         processor_t             processor);
 187
 188 extern void             run_queue_init(
 189                                         run_queue_t             runq);
 190
 191 extern void             thread_timer_expire(
 192                                         void                    *thread,
 193                                         void                    *p1);
 194
 195 /* Set the maximum interrupt level for the thread */
 196 __private_extern__ wait_interrupt_t thread_interrupt_level(
 197                                                 wait_interrupt_t interruptible);
 198
 199 __private_extern__ wait_result_t thread_mark_wait_locked(
 200                                                 thread_t                 thread,
 201                                                 wait_interrupt_t interruptible);
 202
 203 /* Wake up locked thread directly, passing result */
 204 __private_extern__ kern_return_t clear_wait_internal(
 205                                                 thread_t                thread,
 206                                                 wait_result_t   result);
 207
 208 #endif /* MACH_KERNEL_PRIVATE */
 209
 210 __BEGIN_DECLS
 211
 212 #ifdef  XNU_KERNEL_PRIVATE
 213
 214 extern boolean_t                assert_wait_possible(void);
 215
 216 /*
 217  ****************** Only exported until BSD stops using ********************
 218  */
 219
 220 /* Wake up thread directly, passing result */
 221 extern kern_return_t clear_wait(
 222                                                 thread_t                thread,
 223                                                 wait_result_t   result);
 224
 225 /* Start thread running */
 226 extern void             thread_bootstrap_return(void);
 227
 228 /* Return from exception (BSD-visible interface) */
 229 extern void             thread_exception_return(void) __dead2;
 230
 231 #endif  /* XNU_KERNEL_PRIVATE */
 232
 233 /* Context switch */
 234 extern wait_result_t    thread_block(
 235                                                         thread_continue_t       continuation);
 236
 237 extern wait_result_t    thread_block_parameter(
 238                                                         thread_continue_t       continuation,
 239                                                         void                            *parameter);
 240
 241 /* Declare thread will wait on a particular event */
 242 extern wait_result_t    assert_wait(
 243                                                         event_t                         event,
 244                                                         wait_interrupt_t        interruptible);
 245
 246 /* Assert that the thread intends to wait with a timeout */
 247 extern wait_result_t    assert_wait_timeout(
 248                                                         event_t                         event,
 249                                                         wait_interrupt_t        interruptible,
 250                                                         uint32_t                        interval,
 251                                                         uint32_t                        scale_factor);
 252
 253 extern wait_result_t    assert_wait_deadline(
 254                                                         event_t                         event,
 255                                                         wait_interrupt_t        interruptible,
 256                                                         uint64_t                        deadline);
 257
 258 /* Wake up thread (or threads) waiting on a particular event */
 259 extern kern_return_t    thread_wakeup_prim(
 260                                                         event_t                         event,
 261                                                         boolean_t                       one_thread,
 262                                                         wait_result_t           result);
 263
 264 #define thread_wakeup(x)                                        \
 265                         thread_wakeup_prim((x), FALSE, THREAD_AWAKENED)
 266 #define thread_wakeup_with_result(x, z)         \
 267                         thread_wakeup_prim((x), FALSE, (z))
 268 #define thread_wakeup_one(x)                            \
 269                         thread_wakeup_prim((x), TRUE, THREAD_AWAKENED)
 270
 271 extern boolean_t                preemption_enabled(void);
 272
 273 #ifdef  KERNEL_PRIVATE
 274
 275 #ifndef __LP64__
 276
 277 /*
 278  * Obsolete interfaces.
 279  */
 280
 281 extern void             thread_set_timer(
 282                                         uint32_t                interval,
 283                                         uint32_t                scale_factor);
 284
 285 extern void             thread_set_timer_deadline(
 286                                         uint64_t                deadline);
 287
 288 extern void             thread_cancel_timer(void);
 289
 290 #ifndef MACH_KERNEL_PRIVATE
 291
 292 #ifndef ABSOLUTETIME_SCALAR_TYPE
 293
 294 #define thread_set_timer_deadline(a)    \
 295         thread_set_timer_deadline(__OSAbsoluteTime(a))
 296
 297 #endif  /* ABSOLUTETIME_SCALAR_TYPE */
 298
 299 #endif  /* MACH_KERNEL_PRIVATE */
 300
 301 #endif  /* __LP64__ */
 302
 303 #endif  /* KERNEL_PRIVATE */
 304
 305 __END_DECLS
 306
 307 #endif  /* _KERN_SCHED_PRIM_H_ */