[apple/xnu.git] / osfmk / kern / sched_prim.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	sched_prim.h
 *	Author:	David Golub
 *
 *	Scheduling primitive definitions file
 *
 */

#ifndef	_KERN_SCHED_PRIM_H_
#define _KERN_SCHED_PRIM_H_

#include <mach/boolean.h>
#include <mach/machine/vm_types.h>
#include <mach/kern_return.h>
#include <kern/clock.h>
#include <kern/kern_types.h>
#include <kern/thread.h>
#include <kern/lock.h>
#include <kern/time_out.h>	/*** ??? temp - remove me soon ***/
#include <kern/cpu_data.h>

#include <sys/appleapiopts.h>

#ifdef	__APPLE_API_PRIVATE

#ifdef	MACH_KERNEL_PRIVATE

#include <mach_ldebug.h>
/*
 *	Exported interface to sched_prim.c.
 *	A few of these functions are actually defined in
 *	ipc_sched.c, for historical reasons.
 */

/* Initialize scheduler module */
extern void		sched_init(void);

extern void		sched_timebase_init(void);

/*
 * Set up thread timeout element(s) when thread is created.
 */
extern void		thread_timer_setup(
					thread_t		thread);

extern void		thread_timer_terminate(void);

/*
 * Stop a thread and wait for it to stop running.
 */
extern boolean_t	thread_stop( 
						thread_t	thread);

/*
 * Wait for a thread to stop running.
 */
extern boolean_t	thread_wait(
						thread_t	thread);

/* Select a thread to run on a particular processor */
extern thread_t	thread_select(
						processor_t	myprocessor);

extern kern_return_t thread_go_locked(
					 	thread_t		thread,
						wait_result_t	result);

/* Stop old thread and run new thread */
extern boolean_t thread_invoke(
						thread_t		old_thread,
						thread_t		new_thread,
						int				reason,
						thread_continue_t continuation);

/* Called when current thread is given new stack */
extern void		thread_continue(
						thread_t		old_thread);

/* Switch directly to a particular thread */
extern int		thread_run(
						thread_t		old_thread,
						thread_continue_t continuation,
						thread_t		new_thread);

/* Dispatch a thread not on a run queue */
extern void		thread_dispatch(
						thread_t		thread);

/* Invoke continuation */
extern void		call_continuation(
						thread_continue_t continuation);		  

/* Set the current scheduled priority */
extern void		set_sched_pri(
					thread_t		thread,
					int				priority);

/* Set base priority of the specified thread */
extern void		set_priority(
					thread_t		thread,
					int				priority);

/* Reset scheduled priority of thread */
extern void		compute_priority(
					thread_t		thread,
					boolean_t		override_depress);

/* Adjust scheduled priority of thread during execution */
extern void		compute_my_priority(
					thread_t		thread);

/* Periodic scheduler activity */
extern void		sched_tick_init(void);

/*
 * Update thread to the current scheduler tick.
 */
extern void		update_priority(
					thread_t		thread);

/* Idle thread loop */
extern void		idle_thread(void);

/*
 *	Machine-dependent code must define these functions.
 */

/* Start thread running */
extern void		thread_bootstrap_return(void);

/* Return from exception */
extern void		thread_exception_return(void);

/* Continuation return from syscall */
extern void     thread_syscall_return(
                        kern_return_t   ret);

/*
 *	These functions are either defined in kern/thread.c
 *	or are defined directly by machine-dependent code.
 */

/* Block current thread, indicating reason */
extern wait_result_t	thread_block_reason(
							thread_continue_t	continuation,
							ast_t				reason);

/* Dispatch a thread for execution */
extern void		thread_setrun(
					thread_t	thread,
					integer_t	options);

#define SCHED_TAILQ		0
#define SCHED_HEADQ		1
#define SCHED_PREEMPT	2

/* Bind thread to a particular processor */
extern processor_t		thread_bind(
							thread_t		thread,
							processor_t		processor);

/* Set the maximum interrupt level for the thread */
__private_extern__ wait_interrupt_t thread_interrupt_level(
						wait_interrupt_t interruptible);

__private_extern__ wait_result_t thread_mark_wait_locked(
						thread_t		 thread,
						wait_interrupt_t interruptible);

/* Sleep, unlocking and then relocking a usimple_lock in the process */
__private_extern__ wait_result_t thread_sleep_fast_usimple_lock(
						event_t			event,
						simple_lock_t	lock,
						wait_interrupt_t interruptible);

/* Wake up locked thread directly, passing result */
__private_extern__ kern_return_t clear_wait_internal(
						thread_t		thread,
						wait_result_t	result);

__private_extern__
	wait_queue_t	wait_event_wait_queue(
						event_t			event);

#endif /* MACH_KERNEL_PRIVATE */

extern wait_result_t	assert_wait_prim(
							event_t				event,
							thread_roust_t		roust_hint,
							uint64_t			deadline,
							wait_interrupt_t	interruptible);

/*
 ****************** Only exported until BSD stops using ********************
 */

/*
 * Cancel a stop and unblock the thread if already stopped.
 */
extern void		thread_unstop(
						thread_t		thread);

/* Wake up thread directly, passing result */
extern kern_return_t clear_wait(
						thread_t		thread,
						wait_result_t	result);

#endif	/* __APPLE_API_PRIVATE */

/*
 * *********************   PUBLIC APIs ************************************
 */

/* Set timer for current thread */
extern void		thread_set_timer(
					uint32_t		interval,
					uint32_t		scale_factor);

extern void		thread_set_timer_deadline(
					uint64_t		deadline);

extern void		thread_cancel_timer(void);

/* Declare thread will wait on a particular event */
extern wait_result_t assert_wait(
						event_t			 event,
						wait_interrupt_t interruptflag);

/* Assert that the thread intends to wait for a timeout */
extern wait_result_t assert_wait_timeout(
						natural_t		 msecs,
						wait_interrupt_t interruptflags);

/* Sleep, unlocking and then relocking a usimple_lock in the process */
extern wait_result_t thread_sleep_usimple_lock(
						event_t			event,
						usimple_lock_t	lock,
						wait_interrupt_t interruptible);	

/* Sleep, unlocking and then relocking a mutex in the process */
extern wait_result_t thread_sleep_mutex(
						event_t			event,
						mutex_t			*mutex,
						wait_interrupt_t interruptible);	
										
/* Sleep with a deadline, unlocking and then relocking a mutex in the process */
extern wait_result_t thread_sleep_mutex_deadline(
						event_t			event,
						mutex_t			*mutex,
						uint64_t		deadline,
						wait_interrupt_t interruptible);	

/* Sleep, unlocking and then relocking a write lock in the process */
extern wait_result_t thread_sleep_lock_write(
						event_t			event,
						lock_t			*lock,
						wait_interrupt_t interruptible);	
									   
/* Sleep, hinting that a thread funnel may be involved in the process */
extern wait_result_t thread_sleep_funnel(
						event_t			event,
						wait_interrupt_t interruptible);	

/* Wake up thread (or threads) waiting on a particular event */
extern kern_return_t thread_wakeup_prim(
						event_t			event,
						boolean_t		one_thread,
						wait_result_t	result);

#ifdef	__APPLE_API_UNSTABLE

/* Block current thread (Block reason) */
extern wait_result_t thread_block(
						thread_continue_t continuation);

#endif	/* __APPLE_API_UNSTABLE */

/*
 *	Routines defined as macros
 */

#define thread_wakeup(x)					\
			thread_wakeup_prim((x), FALSE, THREAD_AWAKENED)
#define thread_wakeup_with_result(x, z)		\
			thread_wakeup_prim((x), FALSE, (z))
#define thread_wakeup_one(x)				\
			thread_wakeup_prim((x), TRUE, THREAD_AWAKENED)

#if		!defined(MACH_KERNEL_PRIVATE) && !defined(ABSOLUTETIME_SCALAR_TYPE)

#include <libkern/OSBase.h>

#define thread_set_timer_deadline(a)	\
	thread_set_timer_deadline(__OSAbsoluteTime(a))

#endif

#endif	/* _KERN_SCHED_PRIM_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	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.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	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.
1c79356b A	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_prim.h
	54	* Author: David Golub
	55	*
	56	* Scheduling primitive definitions file
	57	*
	58	*/
	59
	60	#ifndef _KERN_SCHED_PRIM_H_
	61	#define _KERN_SCHED_PRIM_H_
	62
	63	#include <mach/boolean.h>
	64	#include <mach/machine/vm_types.h>
	65	#include <mach/kern_return.h>
	66	#include <kern/clock.h>
	67	#include <kern/kern_types.h>
	68	#include <kern/thread.h>
	69	#include <kern/lock.h>
	70	#include <kern/time_out.h> /* ??? temp - remove me soon */
	71	#include <kern/cpu_data.h>
1c79356b	72
9bccf70c A	73	#include <sys/appleapiopts.h>
	74
	75	#ifdef __APPLE_API_PRIVATE
	76
	77	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	78
	79	#include <mach_ldebug.h>
	80	/*
	81	* Exported interface to sched_prim.c.
	82	* A few of these functions are actually defined in
	83	* ipc_sched.c, for historical reasons.
	84	*/
	85
	86	/* Initialize scheduler module */
	87	extern void sched_init(void);
	88
55e303ae A	89	extern void sched_timebase_init(void);
55e303ae A	90
1c79356b A	91	/*
	92	* Set up thread timeout element(s) when thread is created.
	93	*/
	94	extern void thread_timer_setup(
	95	thread_t thread);
	96
	97	extern void thread_timer_terminate(void);
	98
1c79356b	99	/*
9bccf70c	100	* Stop a thread and wait for it to stop running.
1c79356b A	101	*/
	102	extern boolean_t thread_stop(
	103	thread_t thread);
	104
	105	/*
9bccf70c	106	* Wait for a thread to stop running.
1c79356b A	107	*/
	108	extern boolean_t thread_wait(
	109	thread_t thread);
	110
	111	/* Select a thread to run on a particular processor */
	112	extern thread_t thread_select(
	113	processor_t myprocessor);
	114
9bccf70c A	115	extern kern_return_t thread_go_locked(
	116	thread_t thread,
	117	wait_result_t result);
1c79356b A	118
	119	/* Stop old thread and run new thread */
	120	extern boolean_t thread_invoke(
9bccf70c A	121	thread_t old_thread,
	122	thread_t new_thread,
	123	int reason,
	124	thread_continue_t continuation);
1c79356b A	125
	126	/* Called when current thread is given new stack */
	127	extern void thread_continue(
9bccf70c	128	thread_t old_thread);
1c79356b A	129
	130	/* Switch directly to a particular thread */
	131	extern int thread_run(
9bccf70c A	132	thread_t old_thread,
	133	thread_continue_t continuation,
	134	thread_t new_thread);
1c79356b A	135
	136	/* Dispatch a thread not on a run queue */
	137	extern void thread_dispatch(
9bccf70c	138	thread_t thread);
1c79356b A	139
	140	/* Invoke continuation */
	141	extern void call_continuation(
9bccf70c A	142	thread_continue_t continuation);
	143
	144	/* Set the current scheduled priority */
	145	extern void set_sched_pri(
	146	thread_t thread,
	147	int priority);
1c79356b	148
9bccf70c A	149	/* Set base priority of the specified thread */
	150	extern void set_priority(
	151	thread_t thread,
	152	int priority);
	153
	154	/* Reset scheduled priority of thread */
1c79356b	155	extern void compute_priority(
9bccf70c A	156	thread_t thread,
9bccf70c A	157	boolean_t override_depress);
1c79356b	158
9bccf70c	159	/* Adjust scheduled priority of thread during execution */
1c79356b	160	extern void compute_my_priority(
9bccf70c	161	thread_t thread);
1c79356b A	162
1c79356b A	163	/* Periodic scheduler activity */
0b4e3aa0	164	extern void sched_tick_init(void);
1c79356b	165
9bccf70c A	166	/*
9bccf70c A	167	* Update thread to the current scheduler tick.
1c79356b A	168	*/
1c79356b A	169	extern void update_priority(
9bccf70c	170	thread_t thread);
1c79356b A	171
	172	/* Idle thread loop */
	173	extern void idle_thread(void);
	174
1c79356b A	175	/*
	176	* Machine-dependent code must define these functions.
	177	*/
	178
	179	/* Start thread running */
	180	extern void thread_bootstrap_return(void);
	181
	182	/* Return from exception */
	183	extern void thread_exception_return(void);
	184
	185	/* Continuation return from syscall */
	186	extern void thread_syscall_return(
	187	kern_return_t ret);
	188
1c79356b A	189	/*
	190	* These functions are either defined in kern/thread.c
	191	* or are defined directly by machine-dependent code.
	192	*/
	193
9bccf70c A	194	/* Block current thread, indicating reason */
	195	extern wait_result_t thread_block_reason(
	196	thread_continue_t continuation,
	197	ast_t reason);
1c79356b	198
9bccf70c	199	/* Dispatch a thread for execution */
1c79356b	200	extern void thread_setrun(
9bccf70c	201	thread_t thread,
55e303ae	202	integer_t options);
1c79356b	203
55e303ae A	204	#define SCHED_TAILQ 0
	205	#define SCHED_HEADQ 1
	206	#define SCHED_PREEMPT 2
1c79356b A	207
1c79356b A	208	/* Bind thread to a particular processor */
55e303ae A	209	extern processor_t thread_bind(
	210	thread_t thread,
	211	processor_t processor);
1c79356b	212
9bccf70c A	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	/* Sleep, unlocking and then relocking a usimple_lock in the process */
	222	__private_extern__ wait_result_t thread_sleep_fast_usimple_lock(
	223	event_t event,
	224	simple_lock_t lock,
	225	wait_interrupt_t interruptible);
	226
	227	/* Wake up locked thread directly, passing result */
	228	__private_extern__ kern_return_t clear_wait_internal(
	229	thread_t thread,
	230	wait_result_t result);
1c79356b	231
55e303ae A	232	__private_extern__
	233	wait_queue_t wait_event_wait_queue(
	234	event_t event);
	235
1c79356b A	236	#endif /* MACH_KERNEL_PRIVATE */
1c79356b A	237
55e303ae A	238	extern wait_result_t assert_wait_prim(
	239	event_t event,
	240	thread_roust_t roust_hint,
	241	uint64_t deadline,
	242	wait_interrupt_t interruptible);
	243
1c79356b A	244	/*
	245	**************** Only exported until BSD stops using ******************
	246	*/
	247
	248	/*
9bccf70c	249	* Cancel a stop and unblock the thread if already stopped.
1c79356b A	250	*/
1c79356b A	251	extern void thread_unstop(
9bccf70c	252	thread_t thread);
1c79356b A	253
1c79356b A	254	/* Wake up thread directly, passing result */
9bccf70c A	255	extern kern_return_t clear_wait(
	256	thread_t thread,
	257	wait_result_t result);
1c79356b	258
9bccf70c	259	#endif /* __APPLE_API_PRIVATE */
1c79356b A	260
	261	/*
	262	* ******************* PUBLIC APIs **********************************
	263	*/
	264
	265	/* Set timer for current thread */
	266	extern void thread_set_timer(
0b4e3aa0 A	267	uint32_t interval,
0b4e3aa0 A	268	uint32_t scale_factor);
1c79356b A	269
1c79356b A	270	extern void thread_set_timer_deadline(
0b4e3aa0	271	uint64_t deadline);
1c79356b A	272
	273	extern void thread_cancel_timer(void);
	274
1c79356b	275	/* Declare thread will wait on a particular event */
9bccf70c A	276	extern wait_result_t assert_wait(
	277	event_t event,
	278	wait_interrupt_t interruptflag);
1c79356b A	279
1c79356b A	280	/* Assert that the thread intends to wait for a timeout */
9bccf70c A	281	extern wait_result_t assert_wait_timeout(
	282	natural_t msecs,
	283	wait_interrupt_t interruptflags);
	284
	285	/* Sleep, unlocking and then relocking a usimple_lock in the process */
	286	extern wait_result_t thread_sleep_usimple_lock(
	287	event_t event,
	288	usimple_lock_t lock,
	289	wait_interrupt_t interruptible);
	290
	291	/* Sleep, unlocking and then relocking a mutex in the process */
	292	extern wait_result_t thread_sleep_mutex(
	293	event_t event,
	294	mutex_t *mutex,
	295	wait_interrupt_t interruptible);
	296
	297	/* Sleep with a deadline, unlocking and then relocking a mutex in the process */
	298	extern wait_result_t thread_sleep_mutex_deadline(
	299	event_t event,
	300	mutex_t *mutex,
	301	uint64_t deadline,
	302	wait_interrupt_t interruptible);
	303
	304	/* Sleep, unlocking and then relocking a write lock in the process */
	305	extern wait_result_t thread_sleep_lock_write(
	306	event_t event,
	307	lock_t *lock,
	308	wait_interrupt_t interruptible);
	309
	310	/* Sleep, hinting that a thread funnel may be involved in the process */
	311	extern wait_result_t thread_sleep_funnel(
	312	event_t event,
	313	wait_interrupt_t interruptible);
1c79356b A	314
1c79356b A	315	/* Wake up thread (or threads) waiting on a particular event */
9bccf70c A	316	extern kern_return_t thread_wakeup_prim(
	317	event_t event,
	318	boolean_t one_thread,
	319	wait_result_t result);
	320
	321	#ifdef __APPLE_API_UNSTABLE
1c79356b A	322
1c79356b A	323	/* Block current thread (Block reason) */
9bccf70c A	324	extern wait_result_t thread_block(
9bccf70c A	325	thread_continue_t continuation);
1c79356b	326
9bccf70c	327	#endif /* __APPLE_API_UNSTABLE */
1c79356b A	328
	329	/*
	330	* Routines defined as macros
	331	*/
	332
	333	#define thread_wakeup(x) \
	334	thread_wakeup_prim((x), FALSE, THREAD_AWAKENED)
	335	#define thread_wakeup_with_result(x, z) \
	336	thread_wakeup_prim((x), FALSE, (z))
	337	#define thread_wakeup_one(x) \
	338	thread_wakeup_prim((x), TRUE, THREAD_AWAKENED)
	339
0b4e3aa0 A	340	#if !defined(MACH_KERNEL_PRIVATE) && !defined(ABSOLUTETIME_SCALAR_TYPE)
	341
	342	#include <libkern/OSBase.h>
	343
	344	#define thread_set_timer_deadline(a) \
	345	thread_set_timer_deadline(__OSAbsoluteTime(a))
	346
	347	#endif
1c79356b A	348
1c79356b A	349	#endif /* _KERN_SCHED_PRIM_H_ */