osfmk/kern/sched_prim.h

   1 /*
   2  * Copyright (c) 2000-2005 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  * @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);
  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 /* Select a thread to run */
  99 extern thread_t         thread_select(
 100                                                 processor_t             myprocessor);
 101
 102 /* Unblock thread on wake up */
 103 extern boolean_t        thread_unblock(
 104                                                 thread_t                thread,
 105                                                 wait_result_t   wresult);
 106
 107 /* Unblock and dispatch thread */
 108 extern kern_return_t    thread_go(
 109                                                         thread_t                thread,
 110                                                         wait_result_t   wresult);
 111
 112 /* Context switch primitive */
 113 extern boolean_t        thread_invoke(
 114                                                 thread_t                        old_thread,
 115                                                 thread_t                        new_thread,
 116                                                 ast_t                           reason);
 117
 118 /* Perform calculations for thread finishing execution */
 119 extern void                     thread_done(
 120                                                 thread_t                old_thread,
 121                                                 thread_t                new_thread,
 122                                                 processor_t             processor);
 123
 124 /* Set up for thread beginning execution */
 125 extern void                     thread_begin(
 126                                                 thread_t                thread,
 127                                                 processor_t             processor);
 128
 129 /* Handle previous thread at context switch */
 130 extern void                     thread_dispatch(
 131                                                 thread_t                thread);
 132
 133 /* Switch directly to a particular thread */
 134 extern int                      thread_run(
 135                                                 thread_t                        self,
 136                                                 thread_continue_t       continuation,
 137                                                 void                            *parameter,
 138                                                 thread_t                        new_thread);
 139
 140 /* Resume thread with new stack */
 141 extern void                     thread_continue(
 142                                                 thread_t                old_thread);
 143
 144 /* Invoke continuation */
 145 extern void             call_continuation(
 146                                         thread_continue_t       continuation,
 147                                         void                            *parameter,
 148                                         wait_result_t           wresult);
 149
 150 /* Set the current scheduled priority */
 151 extern void             set_sched_pri(
 152                                         thread_t                thread,
 153                                         int                             priority);
 154
 155 /* Set base priority of the specified thread */
 156 extern void             set_priority(
 157                                         thread_t                thread,
 158                                         int                             priority);
 159
 160 /* Reset scheduled priority of thread */
 161 extern void             compute_priority(
 162                                         thread_t                thread,
 163                                         boolean_t               override_depress);
 164
 165 /* Adjust scheduled priority of thread during execution */
 166 extern void             compute_my_priority(
 167                                         thread_t                thread);
 168
 169 /* Periodic scheduler activity */
 170 extern void             sched_tick_thread(void);
 171
 172 /* Perform sched_tick housekeeping activities */
 173 extern void             update_priority(
 174                                         thread_t                thread);
 175
 176 /* Idle processor thread */
 177 extern void             idle_thread(void);
 178
 179 extern kern_return_t    idle_thread_create(
 180                                                         processor_t             processor);
 181
 182 /* Start thread running */
 183 extern void             thread_bootstrap_return(void);
 184
 185 /* Continuation return from syscall */
 186 extern void     thread_syscall_return(
 187                         kern_return_t   ret);
 188
 189 /* Context switch */
 190 extern wait_result_t    thread_block_reason(
 191                                                         thread_continue_t       continuation,
 192                                                         void                            *parameter,
 193                                                         ast_t                           reason);
 194
 195 /* Reschedule thread for execution */
 196 extern void             thread_setrun(
 197                                         thread_t        thread,
 198                                         integer_t       options);
 199
 200 #define SCHED_TAILQ             0
 201 #define SCHED_HEADQ             1
 202 #define SCHED_PREEMPT   2
 203
 204 /* Bind thread to a particular processor */
 205 extern processor_t              thread_bind(
 206                                                         thread_t                thread,
 207                                                         processor_t             processor);
 208
 209 extern void             thread_timer_expire(
 210                                         void                    *thread,
 211                                         void                    *p1);
 212
 213 /* Set the maximum interrupt level for the thread */
 214 __private_extern__ wait_interrupt_t thread_interrupt_level(
 215                                                 wait_interrupt_t interruptible);
 216
 217 __private_extern__ wait_result_t thread_mark_wait_locked(
 218                                                 thread_t                 thread,
 219                                                 wait_interrupt_t interruptible);
 220
 221 /* Wake up locked thread directly, passing result */
 222 __private_extern__ kern_return_t clear_wait_internal(
 223                                                 thread_t                thread,
 224                                                 wait_result_t   result);
 225
 226 #endif /* MACH_KERNEL_PRIVATE */
 227
 228 __BEGIN_DECLS
 229
 230 #ifdef  XNU_KERNEL_PRIVATE
 231
 232 extern boolean_t                assert_wait_possible(void);
 233
 234 /*
 235  ****************** Only exported until BSD stops using ********************
 236  */
 237
 238 /* Wake up thread directly, passing result */
 239 extern kern_return_t clear_wait(
 240                                                 thread_t                thread,
 241                                                 wait_result_t   result);
 242
 243 /* Return from exception (BSD-visible interface) */
 244 extern void             thread_exception_return(void);
 245
 246 #endif  /* XNU_KERNEL_PRIVATE */
 247
 248 /* Context switch */
 249 extern wait_result_t    thread_block(
 250                                                         thread_continue_t       continuation);
 251
 252 extern wait_result_t    thread_block_parameter(
 253                                                         thread_continue_t       continuation,
 254                                                         void                            *parameter);
 255
 256 /* Declare thread will wait on a particular event */
 257 extern wait_result_t    assert_wait(
 258                                                         event_t                         event,
 259                                                         wait_interrupt_t        interruptible);
 260
 261 /* Assert that the thread intends to wait with a timeout */
 262 extern wait_result_t    assert_wait_timeout(
 263                                                         event_t                         event,
 264                                                         wait_interrupt_t        interruptible,
 265                                                         uint32_t                        interval,
 266                                                         uint32_t                        scale_factor);
 267
 268 extern wait_result_t    assert_wait_deadline(
 269                                                         event_t                         event,
 270                                                         wait_interrupt_t        interruptible,
 271                                                         uint64_t                        deadline);
 272
 273 /* Wake up thread (or threads) waiting on a particular event */
 274 extern kern_return_t    thread_wakeup_prim(
 275                                                         event_t                         event,
 276                                                         boolean_t                       one_thread,
 277                                                         wait_result_t           result);
 278
 279 #define thread_wakeup(x)                                        \
 280                         thread_wakeup_prim((x), FALSE, THREAD_AWAKENED)
 281 #define thread_wakeup_with_result(x, z)         \
 282                         thread_wakeup_prim((x), FALSE, (z))
 283 #define thread_wakeup_one(x)                            \
 284                         thread_wakeup_prim((x), TRUE, THREAD_AWAKENED)
 285
 286 extern boolean_t                preemption_enabled(void);
 287
 288 #ifdef  KERNEL_PRIVATE
 289
 290 /*
 291  * Obsolete interfaces.
 292  */
 293
 294 extern void             thread_set_timer(
 295                                         uint32_t                interval,
 296                                         uint32_t                scale_factor);
 297
 298 extern void             thread_set_timer_deadline(
 299                                         uint64_t                deadline);
 300
 301 extern void             thread_cancel_timer(void);
 302
 303 #ifndef MACH_KERNEL_PRIVATE
 304
 305 #ifndef ABSOLUTETIME_SCALAR_TYPE
 306
 307 #define thread_set_timer_deadline(a)    \
 308         thread_set_timer_deadline(__OSAbsoluteTime(a))
 309
 310 #endif  /* ABSOLUTETIME_SCALAR_TYPE */
 311
 312 #endif  /* MACH_KERNEL_PRIVATE */
 313
 314 #endif  /* KERNEL_PRIVATE */
 315
 316 __END_DECLS
 317
 318 #endif  /* _KERN_SCHED_PRIM_H_ */