2 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
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.
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.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
62 * Scheduling primitive definitions file
66 #ifndef _KERN_SCHED_PRIM_H_
67 #define _KERN_SCHED_PRIM_H_
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>
77 #ifdef MACH_KERNEL_PRIVATE
79 #include <mach/branch_predicates.h>
82 extern void sched_init(void);
84 extern void sched_startup(void);
86 extern void sched_timebase_init(void);
88 /* Force a preemption point for a thread and wait for it to stop running */
89 extern boolean_t
thread_stop(
91 boolean_t until_not_runnable
);
93 /* Release a previous stop request */
94 extern void thread_unstop(
97 /* Wait for a thread to stop running */
98 extern void thread_wait(
100 boolean_t until_not_runnable
);
102 /* Unblock thread on wake up */
103 extern boolean_t
thread_unblock(
105 wait_result_t wresult
);
107 /* Unblock and dispatch thread */
108 extern kern_return_t
thread_go(
110 wait_result_t wresult
);
112 /* Handle threads at context switch */
113 extern void thread_dispatch(
115 thread_t new_thread
);
117 /* Switch directly to a particular thread */
118 extern int thread_run(
120 thread_continue_t continuation
,
122 thread_t new_thread
);
124 /* Resume thread with new stack */
125 extern void thread_continue(
126 thread_t old_thread
);
128 /* Invoke continuation */
129 extern void call_continuation(
130 thread_continue_t continuation
,
132 wait_result_t wresult
);
134 /* Set the current scheduled priority */
135 extern void set_sched_pri(
139 /* Set base priority of the specified thread */
140 extern void sched_set_thread_base_priority(
144 /* Set the thread's true scheduling mode */
145 extern void sched_set_thread_mode(thread_t thread
,
147 /* Demote the true scheduler mode */
148 extern void sched_thread_mode_demote(thread_t thread
,
150 /* Un-demote the true scheduler mode */
151 extern void sched_thread_mode_undemote(thread_t thread
,
154 /* Re-evaluate base priority of thread (thread locked) */
155 void thread_recompute_priority(thread_t thread
);
157 /* Re-evaluate base priority of thread (thread unlocked) */
158 void thread_recompute_qos(thread_t thread
);
160 /* Reset scheduled priority of thread */
161 extern void thread_recompute_sched_pri(
163 boolean_t override_depress
);
165 /* Periodic scheduler activity */
166 extern void sched_init_thread(void (*)(void));
168 /* Perform sched_tick housekeeping activities */
169 extern boolean_t
can_update_priority(
172 extern void update_priority(
175 extern void lightweight_update_priority(
178 extern void sched_default_quantum_expire(thread_t thread
);
180 /* Idle processor thread */
181 extern void idle_thread(void);
183 extern kern_return_t
idle_thread_create(
184 processor_t processor
);
186 /* Continuation return from syscall */
187 extern void thread_syscall_return(
191 extern wait_result_t
thread_block_reason(
192 thread_continue_t continuation
,
196 /* Reschedule thread for execution */
197 extern void thread_setrun(
201 #define SCHED_TAILQ 1
202 #define SCHED_HEADQ 2
203 #define SCHED_PREEMPT 4
205 extern uintptr_t sched_thread_on_rt_queue
;
206 #define THREAD_ON_RT_RUNQ ((processor_t)(uintptr_t)&sched_thread_on_rt_queue)
208 extern processor_set_t
task_choose_pset(
211 /* Bind the current thread to a particular processor */
212 extern processor_t
thread_bind(
213 processor_t processor
);
215 /* Choose the best processor to run a thread */
216 extern processor_t
choose_processor(
217 processor_set_t pset
,
218 processor_t processor
,
222 extern void thread_quantum_init(
225 extern void run_queue_init(
228 extern thread_t
run_queue_dequeue(
232 extern boolean_t
run_queue_enqueue(
237 extern void run_queue_remove(
241 struct sched_update_scan_context
243 uint64_t earliest_bg_make_runnable_time
;
244 uint64_t earliest_normal_make_runnable_time
;
245 uint64_t earliest_rt_make_runnable_time
;
247 typedef struct sched_update_scan_context
*sched_update_scan_context_t
;
249 #if defined(CONFIG_SCHED_TIMESHARE_CORE)
251 extern boolean_t
thread_update_add_thread(thread_t thread
);
252 extern void thread_update_process_threads(void);
253 extern boolean_t
runq_scan(run_queue_t runq
, sched_update_scan_context_t scan_context
);
255 extern void sched_timeshare_init(void);
256 extern void sched_timeshare_timebase_init(void);
257 extern void sched_timeshare_maintenance_continue(void);
259 extern boolean_t
priority_is_urgent(int priority
);
260 extern uint32_t sched_timeshare_initial_quantum_size(thread_t thread
);
262 extern int sched_compute_timeshare_priority(thread_t thread
);
264 #endif /* CONFIG_SCHED_TIMESHARE_CORE */
266 extern void rt_runq_scan(sched_update_scan_context_t scan_context
);
268 /* Remove thread from its run queue */
269 extern boolean_t
thread_run_queue_remove(thread_t thread
);
270 thread_t
thread_run_queue_remove_for_handoff(thread_t thread
);
272 /* Put a thread back in the run queue after being yanked */
273 extern void thread_run_queue_reinsert(thread_t thread
, integer_t options
);
275 extern void thread_timer_expire(
279 extern boolean_t
thread_eager_preemption(
282 extern boolean_t sched_generic_direct_dispatch_to_idle_processors
;
284 /* Set the maximum interrupt level for the thread */
285 __private_extern__ wait_interrupt_t
thread_interrupt_level(
286 wait_interrupt_t interruptible
);
288 __private_extern__ wait_result_t
thread_mark_wait_locked(
290 wait_interrupt_t interruptible
);
292 /* Wake up locked thread directly, passing result */
293 __private_extern__ kern_return_t
clear_wait_internal(
295 wait_result_t result
);
297 extern void sched_stats_handle_csw(
298 processor_t processor
,
303 extern void sched_stats_handle_runq_change(
304 struct runq_stats
*stats
,
309 #define SCHED_STATS_CSW(processor, reasons, selfpri, otherpri) \
311 if (__builtin_expect(sched_stats_active, 0)) { \
312 sched_stats_handle_csw((processor), \
313 (reasons), (selfpri), (otherpri)); \
318 #define SCHED_STATS_RUNQ_CHANGE(stats, old_count) \
320 if (__builtin_expect(sched_stats_active, 0)) { \
321 sched_stats_handle_runq_change((stats), \
326 extern uint32_t sched_debug_flags
;
327 #define SCHED_DEBUG_FLAG_PLATFORM_TRACEPOINTS 0x00000001
328 #define SCHED_DEBUG_FLAG_CHOOSE_PROCESSOR_TRACEPOINTS 0x00000002
330 #define SCHED_DEBUG_PLATFORM_KERNEL_DEBUG_CONSTANT(...) do { \
331 if (__improbable(sched_debug_flags & SCHED_DEBUG_FLAG_PLATFORM_TRACEPOINTS)) { \
332 KERNEL_DEBUG_CONSTANT(__VA_ARGS__); \
336 #define SCHED_DEBUG_CHOOSE_PROCESSOR_KERNEL_DEBUG_CONSTANT(...) do { \
337 if (__improbable(sched_debug_flags & SCHED_DEBUG_FLAG_CHOOSE_PROCESSOR_TRACEPOINTS)) { \
338 KERNEL_DEBUG_CONSTANT(__VA_ARGS__); \
342 #define THREAD_URGENCY_NONE 0 /* indicates that there is no currently runnable */
343 #define THREAD_URGENCY_BACKGROUND 1 /* indicates that the thread is marked as a "background" thread */
344 #define THREAD_URGENCY_NORMAL 2 /* indicates that the thread is marked as a "normal" thread */
345 #define THREAD_URGENCY_REAL_TIME 3 /* indicates that the thread is marked as a "real-time" or urgent thread */
346 #define THREAD_URGENCY_MAX 4 /* Marker */
347 /* Returns the "urgency" of a thread (provided by scheduler) */
348 extern int thread_get_urgency(
351 uint64_t *rt_deadline
);
353 /* Tells the "urgency" of the just scheduled thread (provided by CPU PM) */
354 extern void thread_tell_urgency(
357 uint64_t rt_deadline
,
358 uint64_t sched_latency
,
361 /* Tells if there are "active" RT threads in the system (provided by CPU PM) */
362 extern void active_rt_threads(
365 #endif /* MACH_KERNEL_PRIVATE */
369 #ifdef XNU_KERNEL_PRIVATE
371 extern boolean_t
assert_wait_possible(void);
373 /* Toggles a global override to turn off CPU Throttling */
374 #define CPU_THROTTLE_DISABLE 0
375 #define CPU_THROTTLE_ENABLE 1
376 extern void sys_override_cpu_throttle(int flag
);
379 ****************** Only exported until BSD stops using ********************
382 extern void thread_vm_bind_group_add(void);
384 /* Wake up thread directly, passing result */
385 extern kern_return_t
clear_wait(
387 wait_result_t result
);
389 /* Start thread running */
390 extern void thread_bootstrap_return(void);
392 /* Return from exception (BSD-visible interface) */
393 extern void thread_exception_return(void) __dead2
;
395 #define SCHED_STRING_MAX_LENGTH (48)
396 /* String declaring the name of the current scheduler */
397 extern char sched_string
[SCHED_STRING_MAX_LENGTH
];
399 extern kern_return_t
sched_work_interval_notify(thread_t thread
, uint64_t work_interval_id
, uint64_t start
, uint64_t finish
, uint64_t deadline
, uint64_t next_start
, uint32_t flags
);
401 extern thread_t
port_name_to_thread_for_ulock(mach_port_name_t thread_name
);
403 /* Attempt to context switch to a specific runnable thread */
404 extern wait_result_t
thread_handoff(thread_t thread
);
406 extern struct waitq
*assert_wait_queue(event_t event
);
408 extern kern_return_t
thread_wakeup_one_with_pri(event_t event
, int priority
);
410 extern thread_t
thread_wakeup_identify(event_t event
, int priority
);
412 #endif /* XNU_KERNEL_PRIVATE */
415 extern wait_result_t
thread_block(
416 thread_continue_t continuation
);
418 extern wait_result_t
thread_block_parameter(
419 thread_continue_t continuation
,
422 /* Declare thread will wait on a particular event */
423 extern wait_result_t
assert_wait(
425 wait_interrupt_t interruptible
);
427 /* Assert that the thread intends to wait with a timeout */
428 extern wait_result_t
assert_wait_timeout(
430 wait_interrupt_t interruptible
,
432 uint32_t scale_factor
);
434 /* Assert that the thread intends to wait with an urgency, timeout and leeway */
435 extern wait_result_t
assert_wait_timeout_with_leeway(
437 wait_interrupt_t interruptible
,
438 wait_timeout_urgency_t urgency
,
441 uint32_t scale_factor
);
443 extern wait_result_t
assert_wait_deadline(
445 wait_interrupt_t interruptible
,
448 /* Assert that the thread intends to wait with an urgency, deadline, and leeway */
449 extern wait_result_t
assert_wait_deadline_with_leeway(
451 wait_interrupt_t interruptible
,
452 wait_timeout_urgency_t urgency
,
456 /* Wake up thread (or threads) waiting on a particular event */
457 extern kern_return_t
thread_wakeup_prim(
459 boolean_t one_thread
,
460 wait_result_t result
);
462 #define thread_wakeup(x) \
463 thread_wakeup_prim((x), FALSE, THREAD_AWAKENED)
464 #define thread_wakeup_with_result(x, z) \
465 thread_wakeup_prim((x), FALSE, (z))
466 #define thread_wakeup_one(x) \
467 thread_wakeup_prim((x), TRUE, THREAD_AWAKENED)
469 /* Wakeup the specified thread if it is waiting on this event */
470 extern kern_return_t
thread_wakeup_thread(event_t event
, thread_t thread
);
472 extern boolean_t
preemption_enabled(void);
474 #ifdef MACH_KERNEL_PRIVATE
477 * Scheduler algorithm indirection. If only one algorithm is
478 * enabled at compile-time, a direction function call is used.
479 * If more than one is enabled, calls are dispatched through
480 * a function pointer table.
483 #if !defined(CONFIG_SCHED_TRADITIONAL) && !defined(CONFIG_SCHED_PROTO) && !defined(CONFIG_SCHED_GRRR) && !defined(CONFIG_SCHED_MULTIQ)
484 #error Enable at least one scheduler algorithm in osfmk/conf/MASTER.XXX
487 #define SCHED(f) (sched_current_dispatch->f)
489 struct sched_dispatch_table
{
490 const char *sched_name
;
491 void (*init
)(void); /* Init global state */
492 void (*timebase_init
)(void); /* Timebase-dependent initialization */
493 void (*processor_init
)(processor_t processor
); /* Per-processor scheduler init */
494 void (*pset_init
)(processor_set_t pset
); /* Per-processor set scheduler init */
496 void (*maintenance_continuation
)(void); /* Function called regularly */
499 * Choose a thread of greater or equal priority from the per-processor
500 * runqueue for timeshare/fixed threads
502 thread_t (*choose_thread
)(
503 processor_t processor
,
507 /* True if scheduler supports stealing threads */
508 boolean_t steal_thread_enabled
;
511 * Steal a thread from another processor in the pset so that it can run
514 thread_t (*steal_thread
)(
515 processor_set_t pset
);
518 * Compute priority for a timeshare thread based on base priority.
520 int (*compute_timeshare_priority
)(thread_t thread
);
523 * Pick the best processor for a thread (any kind of thread) to run on.
525 processor_t (*choose_processor
)(
526 processor_set_t pset
,
527 processor_t processor
,
530 * Enqueue a timeshare or fixed priority thread onto the per-processor
533 boolean_t (*processor_enqueue
)(
534 processor_t processor
,
538 /* Migrate threads away in preparation for processor shutdown */
539 void (*processor_queue_shutdown
)(
540 processor_t processor
);
542 /* Remove the specific thread from the per-processor runqueue */
543 boolean_t (*processor_queue_remove
)(
544 processor_t processor
,
548 * Does the per-processor runqueue have any timeshare or fixed priority
549 * threads on it? Called without pset lock held, so should
550 * not assume immutability while executing.
552 boolean_t (*processor_queue_empty
)(processor_t processor
);
555 * Would this priority trigger an urgent preemption if it's sitting
556 * on the per-processor runqueue?
558 boolean_t (*priority_is_urgent
)(int priority
);
561 * Does the per-processor runqueue contain runnable threads that
562 * should cause the currently-running thread to be preempted?
564 ast_t (*processor_csw_check
)(processor_t processor
);
567 * Does the per-processor runqueue contain a runnable thread
568 * of > or >= priority, as a preflight for choose_thread() or other
571 boolean_t (*processor_queue_has_priority
)(processor_t processor
,
575 /* Quantum size for the specified non-realtime thread. */
576 uint32_t (*initial_quantum_size
)(thread_t thread
);
578 /* Scheduler mode for a new thread */
579 sched_mode_t (*initial_thread_sched_mode
)(task_t parent_task
);
582 * Is it safe to call update_priority, which may change a thread's
583 * runqueue or other state. This can be used to throttle changes
584 * to dynamic priority.
586 boolean_t (*can_update_priority
)(thread_t thread
);
589 * Update both scheduled priority and other persistent state.
590 * Side effects may including migration to another processor's runqueue.
592 void (*update_priority
)(thread_t thread
);
594 /* Lower overhead update to scheduled priority and state. */
595 void (*lightweight_update_priority
)(thread_t thread
);
597 /* Callback for non-realtime threads when the quantum timer fires */
598 void (*quantum_expire
)(thread_t thread
);
601 * Runnable threads on per-processor runqueue. Should only
602 * be used for relative comparisons of load between processors.
604 int (*processor_runq_count
)(processor_t processor
);
606 /* Aggregate runcount statistics for per-processor runqueue */
607 uint64_t (*processor_runq_stats_count_sum
)(processor_t processor
);
609 boolean_t (*processor_bound_count
)(processor_t processor
);
611 void (*thread_update_scan
)(sched_update_scan_context_t scan_context
);
614 * Use processor->next_thread to pin a thread to an idle
615 * processor. If FALSE, threads are enqueued and can
616 * be stolen by other processors.
618 boolean_t direct_dispatch_to_idle_processors
;
620 /* Supports more than one pset */
621 boolean_t multiple_psets_enabled
;
622 /* Supports scheduler groups */
623 boolean_t sched_groups_enabled
;
626 #if defined(CONFIG_SCHED_TRADITIONAL)
627 extern const struct sched_dispatch_table sched_traditional_dispatch
;
628 extern const struct sched_dispatch_table sched_traditional_with_pset_runqueue_dispatch
;
631 #if defined(CONFIG_SCHED_MULTIQ)
632 extern const struct sched_dispatch_table sched_multiq_dispatch
;
633 extern const struct sched_dispatch_table sched_dualq_dispatch
;
636 #if defined(CONFIG_SCHED_PROTO)
637 extern const struct sched_dispatch_table sched_proto_dispatch
;
640 #if defined(CONFIG_SCHED_GRRR)
641 extern const struct sched_dispatch_table sched_grrr_dispatch
;
645 * It is an error to invoke any scheduler-related code
646 * before this is set up
648 extern const struct sched_dispatch_table
*sched_current_dispatch
;
650 #endif /* MACH_KERNEL_PRIVATE */
654 #endif /* _KERN_SCHED_PRIM_H_ */