2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 1996, 1997
5 * HD Associates, Inc. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by HD Associates, Inc
18 * and Jukka Antero Ukkonen.
19 * 4. Neither the name of the author nor the names of any co-contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Copyright (c) 2002-2008, Jeffrey Roberson <jeff@freebsd.org>
38 * All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice unmodified, this list of conditions, and the following
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
50 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
51 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
54 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
55 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
57 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
59 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
69 * General scheduling info.
72 * Total runnable non-ithread threads in the system.
75 * Runnable threads for this processor.
78 int sched_rr_interval(void);
79 int sched_runnable(void);
82 * Proc related scheduling hooks.
84 void sched_exit(struct proc *p, struct thread *childtd);
85 void sched_fork(struct thread *td, struct thread *childtd);
86 void sched_fork_exit(struct thread *td);
87 void sched_class(struct thread *td, int class);
88 void sched_nice(struct proc *p, int nice);
91 * Threads are switched in and out, block on resources, have temporary
92 * priorities inherited from their procs, and use up cpu time.
94 void sched_exit_thread(struct thread *td, struct thread *child);
95 u_int sched_estcpu(struct thread *td);
96 void sched_fork_thread(struct thread *td, struct thread *child);
97 void sched_lend_prio(struct thread *td, u_char prio);
98 void sched_lend_user_prio(struct thread *td, u_char pri);
99 void sched_lend_user_prio_cond(struct thread *td, u_char pri);
100 fixpt_t sched_pctcpu(struct thread *td);
101 void sched_prio(struct thread *td, u_char prio);
102 void sched_sleep(struct thread *td, int prio);
103 void sched_switch(struct thread *td, struct thread *newtd, int flags);
104 void sched_throw(struct thread *td);
105 void sched_unlend_prio(struct thread *td, u_char prio);
106 void sched_user_prio(struct thread *td, u_char prio);
107 void sched_userret_slowpath(struct thread *td);
108 void sched_wakeup(struct thread *td);
111 fixpt_t sched_pctcpu_delta(struct thread *td);
116 sched_userret(struct thread *td)
120 * XXX we cheat slightly on the locking here to avoid locking in
121 * the usual case. Setting td_priority here is essentially an
122 * incomplete workaround for not setting it properly elsewhere.
123 * Now that some interrupt handlers are threads, not setting it
124 * properly elsewhere can clobber it in the window between setting
125 * it here and returning to user mode, so don't waste time setting
128 KASSERT((td->td_flags & TDF_BORROWING) == 0,
129 ("thread with borrowed priority returning to userland"));
130 if (__predict_false(td->td_priority != td->td_user_pri))
131 sched_userret_slowpath(td);
135 * Threads are moved on and off of run queues
137 void sched_add(struct thread *td, int flags);
138 void sched_clock(struct thread *td);
139 void sched_preempt(struct thread *td);
140 void sched_rem(struct thread *td);
141 void sched_relinquish(struct thread *td);
142 struct thread *sched_choose(void);
143 void sched_idletd(void *);
146 * Binding makes cpu affinity permanent while pinning is used to temporarily
147 * hold a thread on a particular CPU.
149 void sched_bind(struct thread *td, int cpu);
150 static __inline void sched_pin(void);
151 void sched_unbind(struct thread *td);
152 static __inline void sched_unpin(void);
153 int sched_is_bound(struct thread *td);
154 void sched_affinity(struct thread *td);
157 * These procedures tell the process data structure allocation code how
158 * many bytes to actually allocate.
160 int sched_sizeof_proc(void);
161 int sched_sizeof_thread(void);
164 * This routine provides a consistent thread name for use with KTR graphing
167 char *sched_tdname(struct thread *td);
169 void sched_clear_tdname(struct thread *td);
175 curthread->td_pinned++;
183 curthread->td_pinned--;
186 /* sched_add arguments (formerly setrunqueue) */
187 #define SRQ_BORING 0x0000 /* No special circumstances. */
188 #define SRQ_YIELDING 0x0001 /* We are yielding (from mi_switch). */
189 #define SRQ_OURSELF 0x0002 /* It is ourself (from mi_switch). */
190 #define SRQ_INTR 0x0004 /* It is probably urgent. */
191 #define SRQ_PREEMPTED 0x0008 /* has been preempted.. be kind */
192 #define SRQ_BORROWING 0x0010 /* Priority updated due to prio_lend */
194 /* Scheduler stats. */
196 DPCPU_DECLARE(long, sched_switch_stats[SWT_COUNT]);
198 #define SCHED_STAT_DEFINE_VAR(name, ptr, descr) \
199 static void name ## _add_proc(void *dummy __unused) \
202 SYSCTL_ADD_PROC(NULL, \
203 SYSCTL_STATIC_CHILDREN(_kern_sched_stats), OID_AUTO, \
204 #name, CTLTYPE_LONG|CTLFLAG_RD|CTLFLAG_MPSAFE, \
205 ptr, 0, sysctl_dpcpu_long, "LU", descr); \
207 SYSINIT(name, SI_SUB_LAST, SI_ORDER_MIDDLE, name ## _add_proc, NULL);
209 #define SCHED_STAT_DEFINE(name, descr) \
210 DPCPU_DEFINE(unsigned long, name); \
211 SCHED_STAT_DEFINE_VAR(name, &DPCPU_NAME(name), descr)
213 * Sched stats are always incremented in critical sections so no atomic
214 * is necesssary to increment them.
216 #define SCHED_STAT_INC(var) DPCPU_GET(var)++;
218 #define SCHED_STAT_DEFINE_VAR(name, descr, ptr)
219 #define SCHED_STAT_DEFINE(name, descr)
220 #define SCHED_STAT_INC(var) (void)0
224 * Fixup scheduler state for proc0 and thread0
226 void schedinit(void);
229 /* POSIX 1003.1b Process Scheduling */
232 * POSIX scheduling policies
235 #define SCHED_OTHER 2
243 * POSIX scheduling declarations for userland.
246 #include <sys/cdefs.h>
247 #include <sys/_timespec.h>
248 #include <sys/_types.h>
250 #ifndef _PID_T_DECLARED
251 typedef __pid_t pid_t;
252 #define _PID_T_DECLARED
256 int sched_get_priority_max(int);
257 int sched_get_priority_min(int);
258 int sched_getparam(pid_t, struct sched_param *);
259 int sched_getscheduler(pid_t);
260 int sched_rr_get_interval(pid_t, struct timespec *);
261 int sched_setparam(pid_t, const struct sched_param *);
262 int sched_setscheduler(pid_t, int, const struct sched_param *);
263 int sched_yield(void);
267 #endif /* !_SCHED_H_ */