sys/sys/sched.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-4-Clause
   3  *
   4  * Copyright (c) 1996, 1997
   5  *      HD Associates, Inc.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  22  *
  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
  33  * SUCH DAMAGE.
  34  */
  35
  36 /*-
  37  * Copyright (c) 2002-2008, Jeffrey Roberson <jeff@freebsd.org>
  38  * All rights reserved.
  39  *
  40  * Redistribution and use in source and binary forms, with or without
  41  * modification, are permitted provided that the following conditions
  42  * are met:
  43  * 1. Redistributions of source code must retain the above copyright
  44  *    notice unmodified, this list of conditions, and the following
  45  *    disclaimer.
  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.
  49  *
  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.
  60  *
  61  * $FreeBSD$
  62  */
  63
  64 #ifndef _SCHED_H_
  65 #define _SCHED_H_
  66
  67 #ifdef _KERNEL
  68 /*
  69  * General scheduling info.
  70  *
  71  * sched_load:
  72  *      Total runnable non-ithread threads in the system.
  73  *
  74  * sched_runnable:
  75  *      Runnable threads for this processor.
  76  */
  77 int     sched_load(void);
  78 int     sched_rr_interval(void);
  79 int     sched_runnable(void);
  80
  81 /*
  82  * Proc related scheduling hooks.
  83  */
  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);
  89
  90 /*
  91  * Threads are switched in and out, block on resources, have temporary
  92  * priorities inherited from their procs, and use up cpu time.
  93  */
  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 fixpt_t sched_pctcpu(struct thread *td);
 100 void    sched_prio(struct thread *td, u_char prio);
 101 void    sched_sleep(struct thread *td, int prio);
 102 void    sched_switch(struct thread *td, struct thread *newtd, int flags);
 103 void    sched_throw(struct thread *td);
 104 void    sched_unlend_prio(struct thread *td, u_char prio);
 105 void    sched_user_prio(struct thread *td, u_char prio);
 106 void    sched_userret(struct thread *td);
 107 void    sched_wakeup(struct thread *td);
 108 #ifdef  RACCT
 109 #ifdef  SCHED_4BSD
 110 fixpt_t sched_pctcpu_delta(struct thread *td);
 111 #endif
 112 #endif
 113
 114 /*
 115  * Threads are moved on and off of run queues
 116  */
 117 void    sched_add(struct thread *td, int flags);
 118 void    sched_clock(struct thread *td);
 119 void    sched_preempt(struct thread *td);
 120 void    sched_rem(struct thread *td);
 121 void    sched_relinquish(struct thread *td);
 122 struct thread *sched_choose(void);
 123 void    sched_idletd(void *);
 124
 125 /*
 126  * Binding makes cpu affinity permanent while pinning is used to temporarily
 127  * hold a thread on a particular CPU.
 128  */
 129 void    sched_bind(struct thread *td, int cpu);
 130 static __inline void sched_pin(void);
 131 void    sched_unbind(struct thread *td);
 132 static __inline void sched_unpin(void);
 133 int     sched_is_bound(struct thread *td);
 134 void    sched_affinity(struct thread *td);
 135
 136 /*
 137  * These procedures tell the process data structure allocation code how
 138  * many bytes to actually allocate.
 139  */
 140 int     sched_sizeof_proc(void);
 141 int     sched_sizeof_thread(void);
 142
 143 /*
 144  * This routine provides a consistent thread name for use with KTR graphing
 145  * functions.
 146  */
 147 char    *sched_tdname(struct thread *td);
 148 #ifdef KTR
 149 void    sched_clear_tdname(struct thread *td);
 150 #endif
 151
 152 static __inline void
 153 sched_pin(void)
 154 {
 155         curthread->td_pinned++;
 156         __compiler_membar();
 157 }
 158
 159 static __inline void
 160 sched_unpin(void)
 161 {
 162         __compiler_membar();
 163         curthread->td_pinned--;
 164 }
 165
 166 /* sched_add arguments (formerly setrunqueue) */
 167 #define SRQ_BORING      0x0000          /* No special circumstances. */
 168 #define SRQ_YIELDING    0x0001          /* We are yielding (from mi_switch). */
 169 #define SRQ_OURSELF     0x0002          /* It is ourself (from mi_switch). */
 170 #define SRQ_INTR        0x0004          /* It is probably urgent. */
 171 #define SRQ_PREEMPTED   0x0008          /* has been preempted.. be kind */
 172 #define SRQ_BORROWING   0x0010          /* Priority updated due to prio_lend */
 173
 174 /* Scheduler stats. */
 175 #ifdef SCHED_STATS
 176 DPCPU_DECLARE(long, sched_switch_stats[SWT_COUNT]);
 177
 178 #define SCHED_STAT_DEFINE_VAR(name, ptr, descr)                         \
 179 static void name ## _add_proc(void *dummy __unused)                     \
 180 {                                                                       \
 181                                                                         \
 182         SYSCTL_ADD_PROC(NULL,                                           \
 183             SYSCTL_STATIC_CHILDREN(_kern_sched_stats), OID_AUTO,        \
 184             #name, CTLTYPE_LONG|CTLFLAG_RD|CTLFLAG_MPSAFE,              \
 185             ptr, 0, sysctl_dpcpu_long, "LU", descr);                    \
 186 }                                                                       \
 187 SYSINIT(name, SI_SUB_LAST, SI_ORDER_MIDDLE, name ## _add_proc, NULL);
 188
 189 #define SCHED_STAT_DEFINE(name, descr)                                  \
 190     DPCPU_DEFINE(unsigned long, name);                                  \
 191     SCHED_STAT_DEFINE_VAR(name, &DPCPU_NAME(name), descr)
 192 /*
 193  * Sched stats are always incremented in critical sections so no atomic
 194  * is necesssary to increment them.
 195  */
 196 #define SCHED_STAT_INC(var)     DPCPU_GET(var)++;
 197 #else
 198 #define SCHED_STAT_DEFINE_VAR(name, descr, ptr)
 199 #define SCHED_STAT_DEFINE(name, descr)
 200 #define SCHED_STAT_INC(var)                     (void)0
 201 #endif
 202
 203 /*
 204  * Fixup scheduler state for proc0 and thread0
 205  */
 206 void schedinit(void);
 207 #endif /* _KERNEL */
 208
 209 /* POSIX 1003.1b Process Scheduling */
 210
 211 /*
 212  * POSIX scheduling policies
 213  */
 214 #define SCHED_FIFO      1
 215 #define SCHED_OTHER     2
 216 #define SCHED_RR        3
 217
 218 struct sched_param {
 219         int     sched_priority;
 220 };
 221
 222 /*
 223  * POSIX scheduling declarations for userland.
 224  */
 225 #ifndef _KERNEL
 226 #include <sys/cdefs.h>
 227 #include <sys/_timespec.h>
 228 #include <sys/_types.h>
 229
 230 #ifndef _PID_T_DECLARED
 231 typedef __pid_t         pid_t;
 232 #define _PID_T_DECLARED
 233 #endif
 234
 235 __BEGIN_DECLS
 236 int     sched_get_priority_max(int);
 237 int     sched_get_priority_min(int);
 238 int     sched_getparam(pid_t, struct sched_param *);
 239 int     sched_getscheduler(pid_t);
 240 int     sched_rr_get_interval(pid_t, struct timespec *);
 241 int     sched_setparam(pid_t, const struct sched_param *);
 242 int     sched_setscheduler(pid_t, int, const struct sched_param *);
 243 int     sched_yield(void);
 244 __END_DECLS
 245
 246 #endif
 247 #endif /* !_SCHED_H_ */