1/* 2 * Copyright (c) 2000-2006 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 */ 80extern void sched_init(void) __attribute__((section("__TEXT, initcode"))); 81 82extern void sched_startup(void); 83 84extern void sched_timebase_init(void); 85 86/* Force a preemption point for a thread and wait for it to stop running */ 87extern boolean_t thread_stop( 88 thread_t thread); 89 90/* Release a previous stop request */ 91extern void thread_unstop( 92 thread_t thread); 93 94/* Wait for a thread to stop running */ 95extern void thread_wait( 96 thread_t thread); 97 98/* Unblock thread on wake up */ 99extern boolean_t thread_unblock( 100 thread_t thread, 101 wait_result_t wresult); 102 103/* Unblock and dispatch thread */ 104extern kern_return_t thread_go( 105 thread_t thread, 106 wait_result_t wresult); 107 108/* Handle threads at context switch */ 109extern void thread_dispatch( 110 thread_t old_thread, 111 thread_t new_thread); 112 113/* Switch directly to a particular thread */ 114extern 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 */ 121extern void thread_continue( 122 thread_t old_thread); 123 124/* Invoke continuation */ 125extern void call_continuation( 126 thread_continue_t continuation, 127 void *parameter, 128 wait_result_t wresult); 129 130/* Set the current scheduled priority */ 131extern void set_sched_pri( 132 thread_t thread, 133 int priority); 134 135/* Set base priority of the specified thread */ 136extern void set_priority( 137 thread_t thread, 138 int priority); 139 140/* Reset scheduled priority of thread */ 141extern void compute_priority( 142 thread_t thread, 143 boolean_t override_depress); 144 145/* Adjust scheduled priority of thread during execution */ 146extern void compute_my_priority( 147 thread_t thread); 148 149/* Periodic scheduler activity */ 150extern void sched_tick_thread(void); 151 152/* Perform sched_tick housekeeping activities */ 153extern void update_priority( 154 thread_t thread); 155 156/* Idle processor thread */ 157extern void idle_thread(void); 158 159extern kern_return_t idle_thread_create( 160 processor_t processor); 161 162/* Start thread running */ 163extern void thread_bootstrap_return(void); 164 165/* Continuation return from syscall */ 166extern void thread_syscall_return( 167 kern_return_t ret); 168 169/* Context switch */ 170extern wait_result_t thread_block_reason( 171 thread_continue_t continuation, 172 void *parameter, 173 ast_t reason); 174 175/* Reschedule thread for execution */ 176extern void thread_setrun( 177 thread_t thread, 178 integer_t options); 179 180#define SCHED_TAILQ 1 181#define SCHED_HEADQ 2 182#define SCHED_PREEMPT 4 183 184/* Bind the current thread to a particular processor */ 185extern processor_t thread_bind( 186 processor_t processor); 187 188extern void run_queue_init( 189 run_queue_t runq); 190 191extern 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 214extern boolean_t assert_wait_possible(void); 215 216/* 217 ****************** Only exported until BSD stops using ******************** 218 */ 219 220/* Wake up thread directly, passing result */ 221extern kern_return_t clear_wait( 222 thread_t thread, 223 wait_result_t result); 224 225/* Return from exception (BSD-visible interface) */ 226extern void thread_exception_return(void) __dead2; 227 228#endif /* XNU_KERNEL_PRIVATE */ 229 230/* Context switch */ 231extern wait_result_t thread_block( 232 thread_continue_t continuation); 233 234extern wait_result_t thread_block_parameter( 235 thread_continue_t continuation, 236 void *parameter); 237 238/* Declare thread will wait on a particular event */ 239extern wait_result_t assert_wait( 240 event_t event, 241 wait_interrupt_t interruptible); 242 243/* Assert that the thread intends to wait with a timeout */ 244extern wait_result_t assert_wait_timeout( 245 event_t event, 246 wait_interrupt_t interruptible, 247 uint32_t interval, 248 uint32_t scale_factor); 249 250extern wait_result_t assert_wait_deadline( 251 event_t event, 252 wait_interrupt_t interruptible, 253 uint64_t deadline); 254 255/* Wake up thread (or threads) waiting on a particular event */ 256extern kern_return_t thread_wakeup_prim( 257 event_t event, 258 boolean_t one_thread, 259 wait_result_t result); 260 261#define thread_wakeup(x) \ 262 thread_wakeup_prim((x), FALSE, THREAD_AWAKENED) 263#define thread_wakeup_with_result(x, z) \ 264 thread_wakeup_prim((x), FALSE, (z)) 265#define thread_wakeup_one(x) \ 266 thread_wakeup_prim((x), TRUE, THREAD_AWAKENED) 267 268extern boolean_t preemption_enabled(void); 269 270#ifdef KERNEL_PRIVATE 271 272/* 273 * Obsolete interfaces. 274 */ 275 276extern void thread_set_timer( 277 uint32_t interval, 278 uint32_t scale_factor); 279 280extern void thread_set_timer_deadline( 281 uint64_t deadline); 282 283extern void thread_cancel_timer(void); 284 285#ifndef MACH_KERNEL_PRIVATE 286 287#ifndef ABSOLUTETIME_SCALAR_TYPE 288 289#define thread_set_timer_deadline(a) \ 290 thread_set_timer_deadline(__OSAbsoluteTime(a)) 291 292#endif /* ABSOLUTETIME_SCALAR_TYPE */ 293 294#endif /* MACH_KERNEL_PRIVATE */ 295 296#endif /* KERNEL_PRIVATE */ 297 298__END_DECLS 299 300#endif /* _KERN_SCHED_PRIM_H_ */ 301