sched.h revision 164936
1/*-
2 * Copyright (c) 1996, 1997
3 *      HD Associates, Inc.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *      This product includes software developed by HD Associates, Inc
16 *      and Jukka Antero Ukkonen.
17 * 4. Neither the name of the author nor the names of any co-contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 */
33
34/*-
35 * Copyright (c) 2002, Jeffrey Roberson <jeff@freebsd.org>
36 * All rights reserved.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 *    notice unmodified, this list of conditions, and the following
43 *    disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 *    notice, this list of conditions and the following disclaimer in the
46 *    documentation and/or other materials provided with the distribution.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
49 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
50 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
51 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
52 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
53 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
54 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
55 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
57 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58 *
59 * $FreeBSD: head/sys/sys/sched.h 164936 2006-12-06 06:34:57Z julian $
60 */
61
62#ifndef _SCHED_H_
63#define	_SCHED_H_
64
65#ifdef _KERNEL
66/*
67 * General scheduling info.
68 *
69 * sched_load:
70 *	Total runnable non-ithread threads in the system.
71 *
72 * sched_runnable:
73 *	Runnable threads for this processor.
74 */
75int	sched_load(void);
76int	sched_rr_interval(void);
77int	sched_runnable(void);
78
79/*
80 * Proc related scheduling hooks.
81 */
82void	sched_exit(struct proc *p, struct thread *childtd);
83void	sched_fork(struct thread *td, struct thread *childtd);
84
85/*
86 * KSE Groups contain scheduling priority information.  They record the
87 * behavior of groups of KSEs and threads.
88 */
89void	sched_class(struct thread *td, int class);
90void	sched_nice(struct proc *p, int nice);
91
92/*
93 * Threads are switched in and out, block on resources, have temporary
94 * priorities inherited from their procs, and use up cpu time.
95 */
96void	sched_exit_thread(struct thread *td, struct thread *child);
97void	sched_fork_thread(struct thread *td, struct thread *child);
98void	sched_lend_prio(struct thread *td, u_char prio);
99void	sched_lend_user_prio(struct thread *td, u_char pri);
100fixpt_t	sched_pctcpu(struct thread *td);
101void	sched_prio(struct thread *td, u_char prio);
102void	sched_sleep(struct thread *td);
103void	sched_switch(struct thread *td, struct thread *newtd, int flags);
104void	sched_unlend_prio(struct thread *td, u_char prio);
105void	sched_unlend_user_prio(struct thread *td, u_char pri);
106void	sched_user_prio(struct thread *td, u_char prio);
107void	sched_userret(struct thread *td);
108void	sched_wakeup(struct thread *td);
109
110/*
111 * Threads are moved on and off of run queues
112 */
113void	sched_add(struct thread *td, int flags);
114void	sched_clock(struct thread *td);
115void	sched_rem(struct thread *td);
116void	sched_tick(void);
117void	sched_relinquish(struct thread *td);
118
119/*
120 * Binding makes cpu affinity permanent while pinning is used to temporarily
121 * hold a thread on a particular CPU.
122 */
123void	sched_bind(struct thread *td, int cpu);
124static __inline void sched_pin(void);
125void	sched_unbind(struct thread *td);
126static __inline void sched_unpin(void);
127int	sched_is_bound(struct thread *td);
128
129/*
130 * These procedures tell the process data structure allocation code how
131 * many bytes to actually allocate.
132 */
133int	sched_sizeof_proc(void);
134int	sched_sizeof_thread(void);
135
136static __inline void
137sched_pin(void)
138{
139	curthread->td_pinned++;
140}
141
142static __inline void
143sched_unpin(void)
144{
145	curthread->td_pinned--;
146}
147
148/* temporarily here */
149void schedinit(void);
150void sched_init_concurrency(struct proc *p);
151void sched_set_concurrency(struct proc *p, int cuncurrency);
152void sched_schedinit(void);
153void sched_newproc(struct proc *p, struct thread *td);
154void sched_thread_exit(struct thread *td);
155void sched_newthread(struct thread *td);
156#endif /* _KERNEL */
157
158/* POSIX 1003.1b Process Scheduling */
159
160/*
161 * POSIX scheduling policies
162 */
163#define SCHED_FIFO      1
164#define SCHED_OTHER     2
165#define SCHED_RR        3
166
167struct sched_param {
168        int     sched_priority;
169};
170
171/*
172 * POSIX scheduling declarations for userland.
173 */
174#ifndef _KERNEL
175#include <sys/cdefs.h>
176#include <sys/_types.h>
177
178#ifndef _PID_T_DECLARED
179typedef __pid_t         pid_t;
180#define _PID_T_DECLARED
181#endif
182
183struct timespec;
184
185__BEGIN_DECLS
186int     sched_get_priority_max(int);
187int     sched_get_priority_min(int);
188int     sched_getparam(pid_t, struct sched_param *);
189int     sched_getscheduler(pid_t);
190int     sched_rr_get_interval(pid_t, struct timespec *);
191int     sched_setparam(pid_t, const struct sched_param *);
192int     sched_setscheduler(pid_t, int, const struct sched_param *);
193int     sched_yield(void);
194__END_DECLS
195
196#endif
197#endif /* !_SCHED_H_ */
198