sched.h revision 170293
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 170293 2007-06-04 23:50:30Z jeff $ 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); 84void sched_fork_exit(struct thread *td); 85 86/* 87 * KSE Groups contain scheduling priority information. They record the 88 * behavior of groups of KSEs and threads. 89 */ 90void sched_class(struct thread *td, int class); 91void sched_nice(struct proc *p, int nice); 92 93/* 94 * Threads are switched in and out, block on resources, have temporary 95 * priorities inherited from their procs, and use up cpu time. 96 */ 97void sched_exit_thread(struct thread *td, struct thread *child); 98void sched_fork_thread(struct thread *td, struct thread *child); 99void sched_lend_prio(struct thread *td, u_char prio); 100void sched_lend_user_prio(struct thread *td, u_char pri); 101fixpt_t sched_pctcpu(struct thread *td); 102void sched_prio(struct thread *td, u_char prio); 103void sched_sleep(struct thread *td); 104void sched_switch(struct thread *td, struct thread *newtd, int flags); 105void sched_throw(struct thread *td); 106void sched_unlend_prio(struct thread *td, u_char prio); 107void sched_unlend_user_prio(struct thread *td, u_char pri); 108void sched_user_prio(struct thread *td, u_char prio); 109void sched_userret(struct thread *td); 110void sched_wakeup(struct thread *td); 111 112/* 113 * Threads are moved on and off of run queues 114 */ 115void sched_add(struct thread *td, int flags); 116void sched_clock(struct thread *td); 117void sched_rem(struct thread *td); 118void sched_tick(void); 119void sched_relinquish(struct thread *td); 120struct thread *sched_choose(void); 121void sched_idletd(void *); 122 123/* 124 * Binding makes cpu affinity permanent while pinning is used to temporarily 125 * hold a thread on a particular CPU. 126 */ 127void sched_bind(struct thread *td, int cpu); 128static __inline void sched_pin(void); 129void sched_unbind(struct thread *td); 130static __inline void sched_unpin(void); 131int sched_is_bound(struct thread *td); 132 133/* 134 * These procedures tell the process data structure allocation code how 135 * many bytes to actually allocate. 136 */ 137int sched_sizeof_proc(void); 138int sched_sizeof_thread(void); 139 140static __inline void 141sched_pin(void) 142{ 143 curthread->td_pinned++; 144} 145 146static __inline void 147sched_unpin(void) 148{ 149 curthread->td_pinned--; 150} 151 152/* sched_add arguments (formerly setrunqueue) */ 153#define SRQ_BORING 0x0000 /* No special circumstances. */ 154#define SRQ_YIELDING 0x0001 /* We are yielding (from mi_switch). */ 155#define SRQ_OURSELF 0x0002 /* It is ourself (from mi_switch). */ 156#define SRQ_INTR 0x0004 /* It is probably urgent. */ 157#define SRQ_PREEMPTED 0x0008 /* has been preempted.. be kind */ 158#define SRQ_BORROWING 0x0010 /* Priority updated due to prio_lend */ 159 160/* Switch stats. */ 161#ifdef SCHED_STATS 162extern long switch_preempt; 163extern long switch_owepreempt; 164extern long switch_turnstile; 165extern long switch_sleepq; 166extern long switch_sleepqtimo; 167extern long switch_relinquish; 168extern long switch_needresched; 169#define SCHED_STAT_INC(var) atomic_add_long(&(var), 1) 170#else 171#define SCHED_STAT_INC(var) 172#endif 173 174/* temporarily here */ 175void schedinit(void); 176void sched_init_concurrency(struct proc *p); 177void sched_set_concurrency(struct proc *p, int cuncurrency); 178void sched_schedinit(void); 179void sched_newproc(struct proc *p, struct thread *td); 180void sched_newthread(struct thread *td); 181#endif /* _KERNEL */ 182 183/* POSIX 1003.1b Process Scheduling */ 184 185/* 186 * POSIX scheduling policies 187 */ 188#define SCHED_FIFO 1 189#define SCHED_OTHER 2 190#define SCHED_RR 3 191 192struct sched_param { 193 int sched_priority; 194}; 195 196/* 197 * POSIX scheduling declarations for userland. 198 */ 199#ifndef _KERNEL 200#include <sys/cdefs.h> 201#include <sys/_types.h> 202 203#ifndef _PID_T_DECLARED 204typedef __pid_t pid_t; 205#define _PID_T_DECLARED 206#endif 207 208struct timespec; 209 210__BEGIN_DECLS 211int sched_get_priority_max(int); 212int sched_get_priority_min(int); 213int sched_getparam(pid_t, struct sched_param *); 214int sched_getscheduler(pid_t); 215int sched_rr_get_interval(pid_t, struct timespec *); 216int sched_setparam(pid_t, const struct sched_param *); 217int sched_setscheduler(pid_t, int, const struct sched_param *); 218int sched_yield(void); 219__END_DECLS 220 221#endif 222#endif /* !_SCHED_H_ */ 223