sys/kern/sched_ule.c

   1 /*-
   2  * Copyright (c) 2002-2007, Jeffrey Roberson <jeff@freebsd.org>
   3  * 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 unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 /*
  28  * This file implements the ULE scheduler.  ULE supports independent CPU
  29  * run queues and fine grain locking.  It has superior interactive
  30  * performance under load even on uni-processor systems.
  31  *
  32  * etymology:
  33  *   ULE is the last three letters in schedule.  It owes its name to a
  34  * generic user created for a scheduling system by Paul Mikesell at
  35  * Isilon Systems and a general lack of creativity on the part of the author.
  36  */
  37
  38 #include <sys/cdefs.h>
  39 __FBSDID("$FreeBSD$");
  40
  41 #include "opt_hwpmc_hooks.h"
  42 #include "opt_kdtrace.h"
  43 #include "opt_sched.h"
  44
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/kdb.h>
  48 #include <sys/kernel.h>
  49 #include <sys/ktr.h>
  50 #include <sys/lock.h>
  51 #include <sys/mutex.h>
  52 #include <sys/proc.h>
  53 #include <sys/resource.h>
  54 #include <sys/resourcevar.h>
  55 #include <sys/sched.h>
  56 #include <sys/sdt.h>
  57 #include <sys/smp.h>
  58 #include <sys/sx.h>
  59 #include <sys/sysctl.h>
  60 #include <sys/sysproto.h>
  61 #include <sys/turnstile.h>
  62 #include <sys/umtx.h>
  63 #include <sys/vmmeter.h>
  64 #include <sys/cpuset.h>
  65 #include <sys/sbuf.h>
  66
  67 #ifdef HWPMC_HOOKS
  68 #include <sys/pmckern.h>
  69 #endif
  70
  71 #ifdef KDTRACE_HOOKS
  72 #include <sys/dtrace_bsd.h>
  73 int                             dtrace_vtime_active;
  74 dtrace_vtime_switch_func_t      dtrace_vtime_switch_func;
  75 #endif
  76
  77 #include <machine/cpu.h>
  78 #include <machine/smp.h>
  79
  80 #if defined(__powerpc__) && defined(E500)
  81 #error "This architecture is not currently compatible with ULE"
  82 #endif
  83
  84 #define KTR_ULE 0
  85
  86 #define TS_NAME_LEN (MAXCOMLEN + sizeof(" td ") + sizeof(__XSTRING(UINT_MAX)))
  87 #define TDQ_NAME_LEN    (sizeof("sched lock ") + sizeof(__XSTRING(MAXCPU)))
  88 #define TDQ_LOADNAME_LEN        (sizeof("CPU ") + sizeof(__XSTRING(MAXCPU)) - 1 + sizeof(" load"))
  89
  90 /*
  91  * Thread scheduler specific section.  All fields are protected
  92  * by the thread lock.
  93  */
  94 struct td_sched {
  95         struct runq     *ts_runq;       /* Run-queue we're queued on. */
  96         short           ts_flags;       /* TSF_* flags. */
  97         u_char          ts_cpu;         /* CPU that we have affinity for. */
  98         int             ts_rltick;      /* Real last tick, for affinity. */
  99         int             ts_slice;       /* Ticks of slice remaining. */
 100         u_int           ts_slptime;     /* Number of ticks we vol. slept */
 101         u_int           ts_runtime;     /* Number of ticks we were running */
 102         int             ts_ltick;       /* Last tick that we were running on */
 103         int             ts_ftick;       /* First tick that we were running on */
 104         int             ts_ticks;       /* Tick count */
 105 #ifdef KTR
 106         char            ts_name[TS_NAME_LEN];
 107 #endif
 108 };
 109 /* flags kept in ts_flags */
 110 #define TSF_BOUND       0x0001          /* Thread can not migrate. */
 111 #define TSF_XFERABLE    0x0002          /* Thread was added as transferable. */
 112
 113 static struct td_sched td_sched0;
 114
 115 #define THREAD_CAN_MIGRATE(td)  ((td)->td_pinned == 0)
 116 #define THREAD_CAN_SCHED(td, cpu)       \
 117     CPU_ISSET((cpu), &(td)->td_cpuset->cs_mask)
 118
 119 /*
 120  * Priority ranges used for interactive and non-interactive timeshare
 121  * threads.  The timeshare priorities are split up into four ranges.
 122  * The first range handles interactive threads.  The last three ranges
 123  * (NHALF, x, and NHALF) handle non-interactive threads with the outer
 124  * ranges supporting nice values.
 125  */
 126 #define PRI_TIMESHARE_RANGE     (PRI_MAX_TIMESHARE - PRI_MIN_TIMESHARE + 1)
 127 #define PRI_INTERACT_RANGE      ((PRI_TIMESHARE_RANGE - SCHED_PRI_NRESV) / 2)
 128 #define PRI_BATCH_RANGE         (PRI_TIMESHARE_RANGE - PRI_INTERACT_RANGE)
 129
 130 #define PRI_MIN_INTERACT        PRI_MIN_TIMESHARE
 131 #define PRI_MAX_INTERACT        (PRI_MIN_TIMESHARE + PRI_INTERACT_RANGE - 1)
 132 #define PRI_MIN_BATCH           (PRI_MIN_TIMESHARE + PRI_INTERACT_RANGE)
 133 #define PRI_MAX_BATCH           PRI_MAX_TIMESHARE
 134
 135 /*
 136  * Cpu percentage computation macros and defines.
 137  *
 138  * SCHED_TICK_SECS:     Number of seconds to average the cpu usage across.
 139  * SCHED_TICK_TARG:     Number of hz ticks to average the cpu usage across.
 140  * SCHED_TICK_MAX:      Maximum number of ticks before scaling back.
 141  * SCHED_TICK_SHIFT:    Shift factor to avoid rounding away results.
 142  * SCHED_TICK_HZ:       Compute the number of hz ticks for a given ticks count.
 143  * SCHED_TICK_TOTAL:    Gives the amount of time we've been recording ticks.
 144  */
 145 #define SCHED_TICK_SECS         10
 146 #define SCHED_TICK_TARG         (hz * SCHED_TICK_SECS)
 147 #define SCHED_TICK_MAX          (SCHED_TICK_TARG + hz)
 148 #define SCHED_TICK_SHIFT        10
 149 #define SCHED_TICK_HZ(ts)       ((ts)->ts_ticks >> SCHED_TICK_SHIFT)
 150 #define SCHED_TICK_TOTAL(ts)    (max((ts)->ts_ltick - (ts)->ts_ftick, hz))
 151
 152 /*
 153  * These macros determine priorities for non-interactive threads.  They are
 154  * assigned a priority based on their recent cpu utilization as expressed
 155  * by the ratio of ticks to the tick total.  NHALF priorities at the start
 156  * and end of the MIN to MAX timeshare range are only reachable with negative
 157  * or positive nice respectively.
 158  *
 159  * PRI_RANGE:   Priority range for utilization dependent priorities.
 160  * PRI_NRESV:   Number of nice values.
 161  * PRI_TICKS:   Compute a priority in PRI_RANGE from the ticks count and total.
 162  * PRI_NICE:    Determines the part of the priority inherited from nice.
 163  */
 164 #define SCHED_PRI_NRESV         (PRIO_MAX - PRIO_MIN)
 165 #define SCHED_PRI_NHALF         (SCHED_PRI_NRESV / 2)
 166 #define SCHED_PRI_MIN           (PRI_MIN_BATCH + SCHED_PRI_NHALF)
 167 #define SCHED_PRI_MAX           (PRI_MAX_BATCH - SCHED_PRI_NHALF)
 168 #define SCHED_PRI_RANGE         (SCHED_PRI_MAX - SCHED_PRI_MIN + 1)
 169 #define SCHED_PRI_TICKS(ts)                                             \
 170     (SCHED_TICK_HZ((ts)) /                                              \
 171     (roundup(SCHED_TICK_TOTAL((ts)), SCHED_PRI_RANGE) / SCHED_PRI_RANGE))
 172 #define SCHED_PRI_NICE(nice)    (nice)
 173
 174 /*
 175  * These determine the interactivity of a process.  Interactivity differs from
 176  * cpu utilization in that it expresses the voluntary time slept vs time ran
 177  * while cpu utilization includes all time not running.  This more accurately
 178  * models the intent of the thread.
 179  *
 180  * SLP_RUN_MAX: Maximum amount of sleep time + run time we'll accumulate
 181  *              before throttling back.
 182  * SLP_RUN_FORK:        Maximum slp+run time to inherit at fork time.
 183  * INTERACT_MAX:        Maximum interactivity value.  Smaller is better.
 184  * INTERACT_THRESH:     Threshold for placement on the current runq.
 185  */
 186 #define SCHED_SLP_RUN_MAX       ((hz * 5) << SCHED_TICK_SHIFT)
 187 #define SCHED_SLP_RUN_FORK      ((hz / 2) << SCHED_TICK_SHIFT)
 188 #define SCHED_INTERACT_MAX      (100)
 189 #define SCHED_INTERACT_HALF     (SCHED_INTERACT_MAX / 2)
 190 #define SCHED_INTERACT_THRESH   (30)
 191
 192 /*
 193  * tickincr:            Converts a stathz tick into a hz domain scaled by
 194  *                      the shift factor.  Without the shift the error rate
 195  *                      due to rounding would be unacceptably high.
 196  * realstathz:          stathz is sometimes 0 and run off of hz.
 197  * sched_slice:         Runtime of each thread before rescheduling.
 198  * preempt_thresh:      Priority threshold for preemption and remote IPIs.
 199  */
 200 static int sched_interact = SCHED_INTERACT_THRESH;
 201 static int realstathz;
 202 static int tickincr;
 203 static int sched_slice = 1;
 204 #ifdef PREEMPTION
 205 #ifdef FULL_PREEMPTION
 206 static int preempt_thresh = PRI_MAX_IDLE;
 207 #else
 208 static int preempt_thresh = PRI_MIN_KERN;
 209 #endif
 210 #else
 211 static int preempt_thresh = 0;
 212 #endif
 213 static int static_boost = PRI_MIN_BATCH;
 214 static int sched_idlespins = 10000;
 215 static int sched_idlespinthresh = 16;
 216
 217 /*
 218  * tdq - per processor runqs and statistics.  All fields are protected by the
 219  * tdq_lock.  The load and lowpri may be accessed without to avoid excess
 220  * locking in sched_pickcpu();
 221  */
 222 struct tdq {
 223         /* Ordered to improve efficiency of cpu_search() and switch(). */
 224         struct mtx      tdq_lock;               /* run queue lock. */
 225         struct cpu_group *tdq_cg;               /* Pointer to cpu topology. */
 226         volatile int    tdq_load;               /* Aggregate load. */
 227         volatile int    tdq_cpu_idle;           /* cpu_idle() is active. */
 228         int             tdq_sysload;            /* For loadavg, !ITHD load. */
 229         int             tdq_transferable;       /* Transferable thread count. */
 230         short           tdq_switchcnt;          /* Switches this tick. */
 231         short           tdq_oldswitchcnt;       /* Switches last tick. */
 232         u_char          tdq_lowpri;             /* Lowest priority thread. */
 233         u_char          tdq_ipipending;         /* IPI pending. */
 234         u_char          tdq_idx;                /* Current insert index. */
 235         u_char          tdq_ridx;               /* Current removal index. */
 236         struct runq     tdq_realtime;           /* real-time run queue. */
 237         struct runq     tdq_timeshare;          /* timeshare run queue. */
 238         struct runq     tdq_idle;               /* Queue of IDLE threads. */
 239         char            tdq_name[TDQ_NAME_LEN];
 240 #ifdef KTR
 241         char            tdq_loadname[TDQ_LOADNAME_LEN];
 242 #endif
 243 } __aligned(64);
 244
 245 /* Idle thread states and config. */
 246 #define TDQ_RUNNING     1
 247 #define TDQ_IDLE        2
 248
 249 #ifdef SMP
 250 struct cpu_group *cpu_top;              /* CPU topology */
 251
 252 #define SCHED_AFFINITY_DEFAULT  (max(1, hz / 1000))
 253 #define SCHED_AFFINITY(ts, t)   ((ts)->ts_rltick > ticks - ((t) * affinity))
 254
 255 /*
 256  * Run-time tunables.
 257  */
 258 static int rebalance = 1;
 259 static int balance_interval = 128;      /* Default set in sched_initticks(). */
 260 static int affinity;
 261 static int steal_idle = 1;
 262 static int steal_thresh = 2;
 263
 264 /*
 265  * One thread queue per processor.
 266  */
 267 static struct tdq       tdq_cpu[MAXCPU];
 268 static struct tdq       *balance_tdq;
 269 static int balance_ticks;
 270 static DPCPU_DEFINE(uint32_t, randomval);
 271
 272 #define TDQ_SELF()      (&tdq_cpu[PCPU_GET(cpuid)])
 273 #define TDQ_CPU(x)      (&tdq_cpu[(x)])
 274 #define TDQ_ID(x)       ((int)((x) - tdq_cpu))
 275 #else   /* !SMP */
 276 static struct tdq       tdq_cpu;
 277
 278 #define TDQ_ID(x)       (0)
 279 #define TDQ_SELF()      (&tdq_cpu)
 280 #define TDQ_CPU(x)      (&tdq_cpu)
 281 #endif
 282
 283 #define TDQ_LOCK_ASSERT(t, type)        mtx_assert(TDQ_LOCKPTR((t)), (type))
 284 #define TDQ_LOCK(t)             mtx_lock_spin(TDQ_LOCKPTR((t)))
 285 #define TDQ_LOCK_FLAGS(t, f)    mtx_lock_spin_flags(TDQ_LOCKPTR((t)), (f))
 286 #define TDQ_UNLOCK(t)           mtx_unlock_spin(TDQ_LOCKPTR((t)))
 287 #define TDQ_LOCKPTR(t)          (&(t)->tdq_lock)
 288
 289 static void sched_priority(struct thread *);
 290 static void sched_thread_priority(struct thread *, u_char);
 291 static int sched_interact_score(struct thread *);
 292 static void sched_interact_update(struct thread *);
 293 static void sched_interact_fork(struct thread *);
 294 static void sched_pctcpu_update(struct td_sched *, int);
 295
 296 /* Operations on per processor queues */
 297 static struct thread *tdq_choose(struct tdq *);
 298 static void tdq_setup(struct tdq *);
 299 static void tdq_load_add(struct tdq *, struct thread *);
 300 static void tdq_load_rem(struct tdq *, struct thread *);
 301 static __inline void tdq_runq_add(struct tdq *, struct thread *, int);
 302 static __inline void tdq_runq_rem(struct tdq *, struct thread *);
 303 static inline int sched_shouldpreempt(int, int, int);
 304 void tdq_print(int cpu);
 305 static void runq_print(struct runq *rq);
 306 static void tdq_add(struct tdq *, struct thread *, int);
 307 #ifdef SMP
 308 static int tdq_move(struct tdq *, struct tdq *);
 309 static int tdq_idled(struct tdq *);
 310 static void tdq_notify(struct tdq *, struct thread *);
 311 static struct thread *tdq_steal(struct tdq *, int);
 312 static struct thread *runq_steal(struct runq *, int);
 313 static int sched_pickcpu(struct thread *, int);
 314 static void sched_balance(void);
 315 static int sched_balance_pair(struct tdq *, struct tdq *);
 316 static inline struct tdq *sched_setcpu(struct thread *, int, int);
 317 static inline void thread_unblock_switch(struct thread *, struct mtx *);
 318 static struct mtx *sched_switch_migrate(struct tdq *, struct thread *, int);
 319 static int sysctl_kern_sched_topology_spec(SYSCTL_HANDLER_ARGS);
 320 static int sysctl_kern_sched_topology_spec_internal(struct sbuf *sb,
 321     struct cpu_group *cg, int indent);
 322 #endif
 323
 324 static void sched_setup(void *dummy);
 325 SYSINIT(sched_setup, SI_SUB_RUN_QUEUE, SI_ORDER_FIRST, sched_setup, NULL);
 326
 327 static void sched_initticks(void *dummy);
 328 SYSINIT(sched_initticks, SI_SUB_CLOCKS, SI_ORDER_THIRD, sched_initticks,
 329     NULL);
 330
 331 SDT_PROVIDER_DEFINE(sched);
 332
 333 SDT_PROBE_DEFINE3(sched, , , change_pri, change-pri, "struct thread *",
 334     "struct proc *", "uint8_t");
 335 SDT_PROBE_DEFINE3(sched, , , dequeue, dequeue, "struct thread *",
 336     "struct proc *", "void *");
 337 SDT_PROBE_DEFINE4(sched, , , enqueue, enqueue, "struct thread *",
 338     "struct proc *", "void *", "int");
 339 SDT_PROBE_DEFINE4(sched, , , lend_pri, lend-pri, "struct thread *",
 340     "struct proc *", "uint8_t", "struct thread *");
 341 SDT_PROBE_DEFINE2(sched, , , load_change, load-change, "int", "int");
 342 SDT_PROBE_DEFINE2(sched, , , off_cpu, off-cpu, "struct thread *",
 343     "struct proc *");
 344 SDT_PROBE_DEFINE(sched, , , on_cpu, on-cpu);
 345 SDT_PROBE_DEFINE(sched, , , remain_cpu, remain-cpu);
 346 SDT_PROBE_DEFINE2(sched, , , surrender, surrender, "struct thread *",
 347     "struct proc *");
 348
 349 /*
 350  * Print the threads waiting on a run-queue.
 351  */
 352 static void
 353 runq_print(struct runq *rq)
 354 {
 355         struct rqhead *rqh;
 356         struct thread *td;
 357         int pri;
 358         int j;
 359         int i;
 360
 361         for (i = 0; i < RQB_LEN; i++) {
 362                 printf("\t\trunq bits %d 0x%zx\n",
 363                     i, rq->rq_status.rqb_bits[i]);
 364                 for (j = 0; j < RQB_BPW; j++)
 365                         if (rq->rq_status.rqb_bits[i] & (1ul << j)) {
 366                                 pri = j + (i << RQB_L2BPW);
 367                                 rqh = &rq->rq_queues[pri];
 368                                 TAILQ_FOREACH(td, rqh, td_runq) {
 369                                         printf("\t\t\ttd %p(%s) priority %d rqindex %d pri %d\n",
 370                                             td, td->td_name, td->td_priority,
 371                                             td->td_rqindex, pri);
 372                                 }
 373                         }
 374         }
 375 }
 376
 377 /*
 378  * Print the status of a per-cpu thread queue.  Should be a ddb show cmd.
 379  */
 380 void
 381 tdq_print(int cpu)
 382 {
 383         struct tdq *tdq;
 384
 385         tdq = TDQ_CPU(cpu);
 386
 387         printf("tdq %d:\n", TDQ_ID(tdq));
 388         printf("\tlock            %p\n", TDQ_LOCKPTR(tdq));
 389         printf("\tLock name:      %s\n", tdq->tdq_name);
 390         printf("\tload:           %d\n", tdq->tdq_load);
 391         printf("\tswitch cnt:     %d\n", tdq->tdq_switchcnt);
 392         printf("\told switch cnt: %d\n", tdq->tdq_oldswitchcnt);
 393         printf("\ttimeshare idx:  %d\n", tdq->tdq_idx);
 394         printf("\ttimeshare ridx: %d\n", tdq->tdq_ridx);
 395         printf("\tload transferable: %d\n", tdq->tdq_transferable);
 396         printf("\tlowest priority:   %d\n", tdq->tdq_lowpri);
 397         printf("\trealtime runq:\n");
 398         runq_print(&tdq->tdq_realtime);
 399         printf("\ttimeshare runq:\n");
 400         runq_print(&tdq->tdq_timeshare);
 401         printf("\tidle runq:\n");
 402         runq_print(&tdq->tdq_idle);
 403 }
 404
 405 static inline int
 406 sched_shouldpreempt(int pri, int cpri, int remote)
 407 {
 408         /*
 409          * If the new priority is not better than the current priority there is
 410          * nothing to do.
 411          */
 412         if (pri >= cpri)
 413                 return (0);
 414         /*
 415          * Always preempt idle.
 416          */
 417         if (cpri >= PRI_MIN_IDLE)
 418                 return (1);
 419         /*
 420          * If preemption is disabled don't preempt others.
 421          */
 422         if (preempt_thresh == 0)
 423                 return (0);
 424         /*
 425          * Preempt if we exceed the threshold.
 426          */
 427         if (pri <= preempt_thresh)
 428                 return (1);
 429         /*
 430          * If we're interactive or better and there is non-interactive
 431          * or worse running preempt only remote processors.
 432          */
 433         if (remote && pri <= PRI_MAX_INTERACT && cpri > PRI_MAX_INTERACT)
 434                 return (1);
 435         return (0);
 436 }
 437
 438 /*
 439  * Add a thread to the actual run-queue.  Keeps transferable counts up to
 440  * date with what is actually on the run-queue.  Selects the correct
 441  * queue position for timeshare threads.
 442  */
 443 static __inline void
 444 tdq_runq_add(struct tdq *tdq, struct thread *td, int flags)
 445 {
 446         struct td_sched *ts;
 447         u_char pri;
 448
 449         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
 450         THREAD_LOCK_ASSERT(td, MA_OWNED);
 451
 452         pri = td->td_priority;
 453         ts = td->td_sched;
 454         TD_SET_RUNQ(td);
 455         if (THREAD_CAN_MIGRATE(td)) {
 456                 tdq->tdq_transferable++;
 457                 ts->ts_flags |= TSF_XFERABLE;
 458         }
 459         if (pri < PRI_MIN_BATCH) {
 460                 ts->ts_runq = &tdq->tdq_realtime;
 461         } else if (pri <= PRI_MAX_BATCH) {
 462                 ts->ts_runq = &tdq->tdq_timeshare;
 463                 KASSERT(pri <= PRI_MAX_BATCH && pri >= PRI_MIN_BATCH,
 464                         ("Invalid priority %d on timeshare runq", pri));
 465                 /*
 466                  * This queue contains only priorities between MIN and MAX
 467                  * realtime.  Use the whole queue to represent these values.
 468                  */
 469                 if ((flags & (SRQ_BORROWING|SRQ_PREEMPTED)) == 0) {
 470                         pri = RQ_NQS * (pri - PRI_MIN_BATCH) / PRI_BATCH_RANGE;
 471                         pri = (pri + tdq->tdq_idx) % RQ_NQS;
 472                         /*
 473                          * This effectively shortens the queue by one so we
 474                          * can have a one slot difference between idx and
 475                          * ridx while we wait for threads to drain.
 476                          */
 477                         if (tdq->tdq_ridx != tdq->tdq_idx &&
 478                             pri == tdq->tdq_ridx)
 479                                 pri = (unsigned char)(pri - 1) % RQ_NQS;
 480                 } else
 481                         pri = tdq->tdq_ridx;
 482                 runq_add_pri(ts->ts_runq, td, pri, flags);
 483                 return;
 484         } else
 485                 ts->ts_runq = &tdq->tdq_idle;
 486         runq_add(ts->ts_runq, td, flags);
 487 }
 488
 489 /*
 490  * Remove a thread from a run-queue.  This typically happens when a thread
 491  * is selected to run.  Running threads are not on the queue and the
 492  * transferable count does not reflect them.
 493  */
 494 static __inline void
 495 tdq_runq_rem(struct tdq *tdq, struct thread *td)
 496 {
 497         struct td_sched *ts;
 498
 499         ts = td->td_sched;
 500         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
 501         KASSERT(ts->ts_runq != NULL,
 502             ("tdq_runq_remove: thread %p null ts_runq", td));
 503         if (ts->ts_flags & TSF_XFERABLE) {
 504                 tdq->tdq_transferable--;
 505                 ts->ts_flags &= ~TSF_XFERABLE;
 506         }
 507         if (ts->ts_runq == &tdq->tdq_timeshare) {
 508                 if (tdq->tdq_idx != tdq->tdq_ridx)
 509                         runq_remove_idx(ts->ts_runq, td, &tdq->tdq_ridx);
 510                 else
 511                         runq_remove_idx(ts->ts_runq, td, NULL);
 512         } else
 513                 runq_remove(ts->ts_runq, td);
 514 }
 515
 516 /*
 517  * Load is maintained for all threads RUNNING and ON_RUNQ.  Add the load
 518  * for this thread to the referenced thread queue.
 519  */
 520 static void
 521 tdq_load_add(struct tdq *tdq, struct thread *td)
 522 {
 523
 524         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
 525         THREAD_LOCK_ASSERT(td, MA_OWNED);
 526
 527         tdq->tdq_load++;
 528         if ((td->td_flags & TDF_NOLOAD) == 0)
 529                 tdq->tdq_sysload++;
 530         KTR_COUNTER0(KTR_SCHED, "load", tdq->tdq_loadname, tdq->tdq_load);
 531         SDT_PROBE2(sched, , , load_change, (int)TDQ_ID(tdq), tdq->tdq_load);
 532 }
 533
 534 /*
 535  * Remove the load from a thread that is transitioning to a sleep state or
 536  * exiting.
 537  */
 538 static void
 539 tdq_load_rem(struct tdq *tdq, struct thread *td)
 540 {
 541
 542         THREAD_LOCK_ASSERT(td, MA_OWNED);
 543         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
 544         KASSERT(tdq->tdq_load != 0,
 545             ("tdq_load_rem: Removing with 0 load on queue %d", TDQ_ID(tdq)));
 546
 547         tdq->tdq_load--;
 548         if ((td->td_flags & TDF_NOLOAD) == 0)
 549                 tdq->tdq_sysload--;
 550         KTR_COUNTER0(KTR_SCHED, "load", tdq->tdq_loadname, tdq->tdq_load);
 551         SDT_PROBE2(sched, , , load_change, (int)TDQ_ID(tdq), tdq->tdq_load);
 552 }
 553
 554 /*
 555  * Set lowpri to its exact value by searching the run-queue and
 556  * evaluating curthread.  curthread may be passed as an optimization.
 557  */
 558 static void
 559 tdq_setlowpri(struct tdq *tdq, struct thread *ctd)
 560 {
 561         struct thread *td;
 562
 563         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
 564         if (ctd == NULL)
 565                 ctd = pcpu_find(TDQ_ID(tdq))->pc_curthread;
 566         td = tdq_choose(tdq);
 567         if (td == NULL || td->td_priority > ctd->td_priority)
 568                 tdq->tdq_lowpri = ctd->td_priority;
 569         else
 570                 tdq->tdq_lowpri = td->td_priority;
 571 }
 572
 573 #ifdef SMP
 574 struct cpu_search {
 575         cpuset_t cs_mask;
 576         u_int   cs_prefer;
 577         int     cs_pri;         /* Min priority for low. */
 578         int     cs_limit;       /* Max load for low, min load for high. */
 579         int     cs_cpu;
 580         int     cs_load;
 581 };
 582
 583 #define CPU_SEARCH_LOWEST       0x1
 584 #define CPU_SEARCH_HIGHEST      0x2
 585 #define CPU_SEARCH_BOTH         (CPU_SEARCH_LOWEST|CPU_SEARCH_HIGHEST)
 586
 587 #define CPUSET_FOREACH(cpu, mask)                               \
 588         for ((cpu) = 0; (cpu) <= mp_maxid; (cpu)++)             \
 589                 if (CPU_ISSET(cpu, &mask))
 590
 591 static __inline int cpu_search(const struct cpu_group *cg, struct cpu_search *low,
 592     struct cpu_search *high, const int match);
 593 int cpu_search_lowest(const struct cpu_group *cg, struct cpu_search *low);
 594 int cpu_search_highest(const struct cpu_group *cg, struct cpu_search *high);
 595 int cpu_search_both(const struct cpu_group *cg, struct cpu_search *low,
 596     struct cpu_search *high);
 597
 598 /*
 599  * Search the tree of cpu_groups for the lowest or highest loaded cpu
 600  * according to the match argument.  This routine actually compares the
 601  * load on all paths through the tree and finds the least loaded cpu on
 602  * the least loaded path, which may differ from the least loaded cpu in
 603  * the system.  This balances work among caches and busses.
 604  *
 605  * This inline is instantiated in three forms below using constants for the
 606  * match argument.  It is reduced to the minimum set for each case.  It is
 607  * also recursive to the depth of the tree.
 608  */
 609 static __inline int
 610 cpu_search(const struct cpu_group *cg, struct cpu_search *low,
 611     struct cpu_search *high, const int match)
 612 {
 613         struct cpu_search lgroup;
 614         struct cpu_search hgroup;
 615         cpuset_t cpumask;
 616         struct cpu_group *child;
 617         struct tdq *tdq;
 618         int cpu, i, hload, lload, load, total, rnd;
 619
 620         total = 0;
 621         cpumask = cg->cg_mask;
 622         if (match & CPU_SEARCH_LOWEST) {
 623                 lload = INT_MAX;
 624                 low->cs_load = INT_MAX;
 625                 lgroup = *low;
 626         }
 627         if (match & CPU_SEARCH_HIGHEST) {
 628                 hload = -1;
 629                 high->cs_load = -1;
 630                 hgroup = *high;
 631         }
 632
 633         /* Iterate through the child CPU groups and then remaining CPUs. */
 634         for (i = 0, cpu = 0; i <= cg->cg_children; ) {
 635                 if (i >= cg->cg_children) {
 636                         while (cpu <= mp_maxid && !CPU_ISSET(cpu, &cpumask))
 637                                 cpu++;
 638                         if (cpu > mp_maxid)
 639                                 break;
 640                         child = NULL;
 641                 } else
 642                         child = &cg->cg_child[i];
 643
 644                 if (child) {                    /* Handle child CPU group. */
 645                         CPU_NAND(&cpumask, &child->cg_mask);
 646                         switch (match) {
 647                         case CPU_SEARCH_LOWEST:
 648                                 load = cpu_search_lowest(child, &lgroup);
 649                                 break;
 650                         case CPU_SEARCH_HIGHEST:
 651                                 load = cpu_search_highest(child, &hgroup);
 652                                 break;
 653                         case CPU_SEARCH_BOTH:
 654                                 load = cpu_search_both(child, &lgroup, &hgroup);
 655                                 break;
 656                         }
 657                 } else {                        /* Handle child CPU. */
 658                         tdq = TDQ_CPU(cpu);
 659                         load = tdq->tdq_load * 256;
 660                         rnd = DPCPU_SET(randomval,
 661                             DPCPU_GET(randomval) * 69069 + 5) >> 26;
 662                         if (match & CPU_SEARCH_LOWEST) {
 663                                 if (cpu == low->cs_prefer)
 664                                         load -= 64;
 665                                 /* If that CPU is allowed and get data. */
 666                                 if (CPU_ISSET(cpu, &lgroup.cs_mask) &&
 667                                     tdq->tdq_lowpri > lgroup.cs_pri &&
 668                                     tdq->tdq_load <= lgroup.cs_limit) {
 669                                         lgroup.cs_cpu = cpu;
 670                                         lgroup.cs_load = load - rnd;
 671                                 }
 672                         }
 673                         if (match & CPU_SEARCH_HIGHEST)
 674                                 if (CPU_ISSET(cpu, &hgroup.cs_mask) &&
 675                                     tdq->tdq_load >= hgroup.cs_limit &&
 676                                     tdq->tdq_transferable) {
 677                                         hgroup.cs_cpu = cpu;
 678                                         hgroup.cs_load = load - rnd;
 679                                 }
 680                 }
 681                 total += load;
 682
 683                 /* We have info about child item. Compare it. */
 684                 if (match & CPU_SEARCH_LOWEST) {
 685                         if (lgroup.cs_load != INT_MAX &&
 686                             (load < lload ||
 687                              (load == lload && lgroup.cs_load < low->cs_load))) {
 688                                 lload = load;
 689                                 low->cs_cpu = lgroup.cs_cpu;
 690                                 low->cs_load = lgroup.cs_load;
 691                         }
 692                 }
 693                 if (match & CPU_SEARCH_HIGHEST)
 694                         if (hgroup.cs_load >= 0 &&
 695                             (load > hload ||
 696                              (load == hload && hgroup.cs_load > high->cs_load))) {
 697                                 hload = load;
 698                                 high->cs_cpu = hgroup.cs_cpu;
 699                                 high->cs_load = hgroup.cs_load;
 700                         }
 701                 if (child)
 702                         i++;
 703                 else
 704                         cpu++;
 705         }
 706         return (total);
 707 }
 708
 709 /*
 710  * cpu_search instantiations must pass constants to maintain the inline
 711  * optimization.
 712  */
 713 int
 714 cpu_search_lowest(const struct cpu_group *cg, struct cpu_search *low)
 715 {
 716         return cpu_search(cg, low, NULL, CPU_SEARCH_LOWEST);
 717 }
 718
 719 int
 720 cpu_search_highest(const struct cpu_group *cg, struct cpu_search *high)
 721 {
 722         return cpu_search(cg, NULL, high, CPU_SEARCH_HIGHEST);
 723 }
 724
 725 int
 726 cpu_search_both(const struct cpu_group *cg, struct cpu_search *low,
 727     struct cpu_search *high)
 728 {
 729         return cpu_search(cg, low, high, CPU_SEARCH_BOTH);
 730 }
 731
 732 /*
 733  * Find the cpu with the least load via the least loaded path that has a
 734  * lowpri greater than pri  pri.  A pri of -1 indicates any priority is
 735  * acceptable.
 736  */
 737 static inline int
 738 sched_lowest(const struct cpu_group *cg, cpuset_t mask, int pri, int maxload,
 739     int prefer)
 740 {
 741         struct cpu_search low;
 742
 743         low.cs_cpu = -1;
 744         low.cs_prefer = prefer;
 745         low.cs_mask = mask;
 746         low.cs_pri = pri;
 747         low.cs_limit = maxload;
 748         cpu_search_lowest(cg, &low);
 749         return low.cs_cpu;
 750 }
 751
 752 /*
 753  * Find the cpu with the highest load via the highest loaded path.
 754  */
 755 static inline int
 756 sched_highest(const struct cpu_group *cg, cpuset_t mask, int minload)
 757 {
 758         struct cpu_search high;
 759
 760         high.cs_cpu = -1;
 761         high.cs_mask = mask;
 762         high.cs_limit = minload;
 763         cpu_search_highest(cg, &high);
 764         return high.cs_cpu;
 765 }
 766
 767 /*
 768  * Simultaneously find the highest and lowest loaded cpu reachable via
 769  * cg.
 770  */
 771 static inline void
 772 sched_both(const struct cpu_group *cg, cpuset_t mask, int *lowcpu, int *highcpu)
 773 {
 774         struct cpu_search high;
 775         struct cpu_search low;
 776
 777         low.cs_cpu = -1;
 778         low.cs_prefer = -1;
 779         low.cs_pri = -1;
 780         low.cs_limit = INT_MAX;
 781         low.cs_mask = mask;
 782         high.cs_cpu = -1;
 783         high.cs_limit = -1;
 784         high.cs_mask = mask;
 785         cpu_search_both(cg, &low, &high);
 786         *lowcpu = low.cs_cpu;
 787         *highcpu = high.cs_cpu;
 788         return;
 789 }
 790
 791 static void
 792 sched_balance_group(struct cpu_group *cg)
 793 {
 794         cpuset_t hmask, lmask;
 795         int high, low, anylow;
 796
 797         CPU_FILL(&hmask);
 798         for (;;) {
 799                 high = sched_highest(cg, hmask, 1);
 800                 /* Stop if there is no more CPU with transferrable threads. */
 801                 if (high == -1)
 802                         break;
 803                 CPU_CLR(high, &hmask);
 804                 CPU_COPY(&hmask, &lmask);
 805                 /* Stop if there is no more CPU left for low. */
 806                 if (CPU_EMPTY(&lmask))
 807                         break;
 808                 anylow = 1;
 809 nextlow:
 810                 low = sched_lowest(cg, lmask, -1,
 811                     TDQ_CPU(high)->tdq_load - 1, high);
 812                 /* Stop if we looked well and found no less loaded CPU. */
 813                 if (anylow && low == -1)
 814                         break;
 815                 /* Go to next high if we found no less loaded CPU. */
 816                 if (low == -1)
 817                         continue;
 818                 /* Transfer thread from high to low. */
 819                 if (sched_balance_pair(TDQ_CPU(high), TDQ_CPU(low))) {
 820                         /* CPU that got thread can no longer be a donor. */
 821                         CPU_CLR(low, &hmask);
 822                 } else {
 823                         /*
 824                          * If failed, then there is no threads on high
 825                          * that can run on this low. Drop low from low
 826                          * mask and look for different one.
 827                          */
 828                         CPU_CLR(low, &lmask);
 829                         anylow = 0;
 830                         goto nextlow;
 831                 }
 832         }
 833 }
 834
 835 static void
 836 sched_balance(void)
 837 {
 838         struct tdq *tdq;
 839
 840         /*
 841          * Select a random time between .5 * balance_interval and
 842          * 1.5 * balance_interval.
 843          */
 844         balance_ticks = max(balance_interval / 2, 1);
 845         balance_ticks += random() % balance_interval;
 846         if (smp_started == 0 || rebalance == 0)
 847                 return;
 848         tdq = TDQ_SELF();
 849         TDQ_UNLOCK(tdq);
 850         sched_balance_group(cpu_top);
 851         TDQ_LOCK(tdq);
 852 }
 853
 854 /*
 855  * Lock two thread queues using their address to maintain lock order.
 856  */
 857 static void
 858 tdq_lock_pair(struct tdq *one, struct tdq *two)
 859 {
 860         if (one < two) {
 861                 TDQ_LOCK(one);
 862                 TDQ_LOCK_FLAGS(two, MTX_DUPOK);
 863         } else {
 864                 TDQ_LOCK(two);
 865                 TDQ_LOCK_FLAGS(one, MTX_DUPOK);
 866         }
 867 }
 868
 869 /*
 870  * Unlock two thread queues.  Order is not important here.
 871  */
 872 static void
 873 tdq_unlock_pair(struct tdq *one, struct tdq *two)
 874 {
 875         TDQ_UNLOCK(one);
 876         TDQ_UNLOCK(two);
 877 }
 878
 879 /*
 880  * Transfer load between two imbalanced thread queues.
 881  */
 882 static int
 883 sched_balance_pair(struct tdq *high, struct tdq *low)
 884 {
 885         int moved;
 886         int cpu;
 887
 888         tdq_lock_pair(high, low);
 889         moved = 0;
 890         /*
 891          * Determine what the imbalance is and then adjust that to how many
 892          * threads we actually have to give up (transferable).
 893          */
 894         if (high->tdq_transferable != 0 && high->tdq_load > low->tdq_load &&
 895             (moved = tdq_move(high, low)) > 0) {
 896                 /*
 897                  * In case the target isn't the current cpu IPI it to force a
 898                  * reschedule with the new workload.
 899                  */
 900                 cpu = TDQ_ID(low);
 901                 sched_pin();
 902                 if (cpu != PCPU_GET(cpuid))
 903                         ipi_cpu(cpu, IPI_PREEMPT);
 904                 sched_unpin();
 905         }
 906         tdq_unlock_pair(high, low);
 907         return (moved);
 908 }
 909
 910 /*
 911  * Move a thread from one thread queue to another.
 912  */
 913 static int
 914 tdq_move(struct tdq *from, struct tdq *to)
 915 {
 916         struct td_sched *ts;
 917         struct thread *td;
 918         struct tdq *tdq;
 919         int cpu;
 920
 921         TDQ_LOCK_ASSERT(from, MA_OWNED);
 922         TDQ_LOCK_ASSERT(to, MA_OWNED);
 923
 924         tdq = from;
 925         cpu = TDQ_ID(to);
 926         td = tdq_steal(tdq, cpu);
 927         if (td == NULL)
 928                 return (0);
 929         ts = td->td_sched;
 930         /*
 931          * Although the run queue is locked the thread may be blocked.  Lock
 932          * it to clear this and acquire the run-queue lock.
 933          */
 934         thread_lock(td);
 935         /* Drop recursive lock on from acquired via thread_lock(). */
 936         TDQ_UNLOCK(from);
 937         sched_rem(td);
 938         ts->ts_cpu = cpu;
 939         td->td_lock = TDQ_LOCKPTR(to);
 940         tdq_add(to, td, SRQ_YIELDING);
 941         return (1);
 942 }
 943
 944 /*
 945  * This tdq has idled.  Try to steal a thread from another cpu and switch
 946  * to it.
 947  */
 948 static int
 949 tdq_idled(struct tdq *tdq)
 950 {
 951         struct cpu_group *cg;
 952         struct tdq *steal;
 953         cpuset_t mask;
 954         int thresh;
 955         int cpu;
 956
 957         if (smp_started == 0 || steal_idle == 0)
 958                 return (1);
 959         CPU_FILL(&mask);
 960         CPU_CLR(PCPU_GET(cpuid), &mask);
 961         /* We don't want to be preempted while we're iterating. */
 962         spinlock_enter();
 963         for (cg = tdq->tdq_cg; cg != NULL; ) {
 964                 if ((cg->cg_flags & CG_FLAG_THREAD) == 0)
 965                         thresh = steal_thresh;
 966                 else
 967                         thresh = 1;
 968                 cpu = sched_highest(cg, mask, thresh);
 969                 if (cpu == -1) {
 970                         cg = cg->cg_parent;
 971                         continue;
 972                 }
 973                 steal = TDQ_CPU(cpu);
 974                 CPU_CLR(cpu, &mask);
 975                 tdq_lock_pair(tdq, steal);
 976                 if (steal->tdq_load < thresh || steal->tdq_transferable == 0) {
 977                         tdq_unlock_pair(tdq, steal);
 978                         continue;
 979                 }
 980                 /*
 981                  * If a thread was added while interrupts were disabled don't
 982                  * steal one here.  If we fail to acquire one due to affinity
 983                  * restrictions loop again with this cpu removed from the
 984                  * set.
 985                  */
 986                 if (tdq->tdq_load == 0 && tdq_move(steal, tdq) == 0) {
 987                         tdq_unlock_pair(tdq, steal);
 988                         continue;
 989                 }
 990                 spinlock_exit();
 991                 TDQ_UNLOCK(steal);
 992                 mi_switch(SW_VOL | SWT_IDLE, NULL);
 993                 thread_unlock(curthread);
 994
 995                 return (0);
 996         }
 997         spinlock_exit();
 998         return (1);
 999 }
1000
1001 /*
1002  * Notify a remote cpu of new work.  Sends an IPI if criteria are met.
1003  */
1004 static void
1005 tdq_notify(struct tdq *tdq, struct thread *td)
1006 {
1007         struct thread *ctd;
1008         int pri;
1009         int cpu;
1010
1011         if (tdq->tdq_ipipending)
1012                 return;
1013         cpu = td->td_sched->ts_cpu;
1014         pri = td->td_priority;
1015         ctd = pcpu_find(cpu)->pc_curthread;
1016         if (!sched_shouldpreempt(pri, ctd->td_priority, 1))
1017                 return;
1018         if (TD_IS_IDLETHREAD(ctd)) {
1019                 /*
1020                  * If the MD code has an idle wakeup routine try that before
1021                  * falling back to IPI.
1022                  */
1023                 if (!tdq->tdq_cpu_idle || cpu_idle_wakeup(cpu))
1024                         return;
1025         }
1026         tdq->tdq_ipipending = 1;
1027         ipi_cpu(cpu, IPI_PREEMPT);
1028 }
1029
1030 /*
1031  * Steals load from a timeshare queue.  Honors the rotating queue head
1032  * index.
1033  */
1034 static struct thread *
1035 runq_steal_from(struct runq *rq, int cpu, u_char start)
1036 {
1037         struct rqbits *rqb;
1038         struct rqhead *rqh;
1039         struct thread *td, *first;
1040         int bit;
1041         int pri;
1042         int i;
1043
1044         rqb = &rq->rq_status;
1045         bit = start & (RQB_BPW -1);
1046         pri = 0;
1047         first = NULL;
1048 again:
1049         for (i = RQB_WORD(start); i < RQB_LEN; bit = 0, i++) {
1050                 if (rqb->rqb_bits[i] == 0)
1051                         continue;
1052                 if (bit != 0) {
1053                         for (pri = bit; pri < RQB_BPW; pri++)
1054                                 if (rqb->rqb_bits[i] & (1ul << pri))
1055                                         break;
1056                         if (pri >= RQB_BPW)
1057                                 continue;
1058                 } else
1059                         pri = RQB_FFS(rqb->rqb_bits[i]);
1060                 pri += (i << RQB_L2BPW);
1061                 rqh = &rq->rq_queues[pri];
1062                 TAILQ_FOREACH(td, rqh, td_runq) {
1063                         if (first && THREAD_CAN_MIGRATE(td) &&
1064                             THREAD_CAN_SCHED(td, cpu))
1065                                 return (td);
1066                         first = td;
1067                 }
1068         }
1069         if (start != 0) {
1070                 start = 0;
1071                 goto again;
1072         }
1073
1074         if (first && THREAD_CAN_MIGRATE(first) &&
1075             THREAD_CAN_SCHED(first, cpu))
1076                 return (first);
1077         return (NULL);
1078 }
1079
1080 /*
1081  * Steals load from a standard linear queue.
1082  */
1083 static struct thread *
1084 runq_steal(struct runq *rq, int cpu)
1085 {
1086         struct rqhead *rqh;
1087         struct rqbits *rqb;
1088         struct thread *td;
1089         int word;
1090         int bit;
1091
1092         rqb = &rq->rq_status;
1093         for (word = 0; word < RQB_LEN; word++) {
1094                 if (rqb->rqb_bits[word] == 0)
1095                         continue;
1096                 for (bit = 0; bit < RQB_BPW; bit++) {
1097                         if ((rqb->rqb_bits[word] & (1ul << bit)) == 0)
1098                                 continue;
1099                         rqh = &rq->rq_queues[bit + (word << RQB_L2BPW)];
1100                         TAILQ_FOREACH(td, rqh, td_runq)
1101                                 if (THREAD_CAN_MIGRATE(td) &&
1102                                     THREAD_CAN_SCHED(td, cpu))
1103                                         return (td);
1104                 }
1105         }
1106         return (NULL);
1107 }
1108
1109 /*
1110  * Attempt to steal a thread in priority order from a thread queue.
1111  */
1112 static struct thread *
1113 tdq_steal(struct tdq *tdq, int cpu)
1114 {
1115         struct thread *td;
1116
1117         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
1118         if ((td = runq_steal(&tdq->tdq_realtime, cpu)) != NULL)
1119                 return (td);
1120         if ((td = runq_steal_from(&tdq->tdq_timeshare,
1121             cpu, tdq->tdq_ridx)) != NULL)
1122                 return (td);
1123         return (runq_steal(&tdq->tdq_idle, cpu));
1124 }
1125
1126 /*
1127  * Sets the thread lock and ts_cpu to match the requested cpu.  Unlocks the
1128  * current lock and returns with the assigned queue locked.
1129  */
1130 static inline struct tdq *
1131 sched_setcpu(struct thread *td, int cpu, int flags)
1132 {
1133
1134         struct tdq *tdq;
1135
1136         THREAD_LOCK_ASSERT(td, MA_OWNED);
1137         tdq = TDQ_CPU(cpu);
1138         td->td_sched->ts_cpu = cpu;
1139         /*
1140          * If the lock matches just return the queue.
1141          */
1142         if (td->td_lock == TDQ_LOCKPTR(tdq))
1143                 return (tdq);
1144 #ifdef notyet
1145         /*
1146          * If the thread isn't running its lockptr is a
1147          * turnstile or a sleepqueue.  We can just lock_set without
1148          * blocking.
1149          */
1150         if (TD_CAN_RUN(td)) {
1151                 TDQ_LOCK(tdq);
1152                 thread_lock_set(td, TDQ_LOCKPTR(tdq));
1153                 return (tdq);
1154         }
1155 #endif
1156         /*
1157          * The hard case, migration, we need to block the thread first to
1158          * prevent order reversals with other cpus locks.
1159          */
1160         spinlock_enter();
1161         thread_lock_block(td);
1162         TDQ_LOCK(tdq);
1163         thread_lock_unblock(td, TDQ_LOCKPTR(tdq));
1164         spinlock_exit();
1165         return (tdq);
1166 }
1167
1168 SCHED_STAT_DEFINE(pickcpu_intrbind, "Soft interrupt binding");
1169 SCHED_STAT_DEFINE(pickcpu_idle_affinity, "Picked idle cpu based on affinity");
1170 SCHED_STAT_DEFINE(pickcpu_affinity, "Picked cpu based on affinity");
1171 SCHED_STAT_DEFINE(pickcpu_lowest, "Selected lowest load");
1172 SCHED_STAT_DEFINE(pickcpu_local, "Migrated to current cpu");
1173 SCHED_STAT_DEFINE(pickcpu_migration, "Selection may have caused migration");
1174
1175 static int
1176 sched_pickcpu(struct thread *td, int flags)
1177 {
1178         struct cpu_group *cg, *ccg;
1179         struct td_sched *ts;
1180         struct tdq *tdq;
1181         cpuset_t mask;
1182         int cpu, pri, self;
1183
1184         self = PCPU_GET(cpuid);
1185         ts = td->td_sched;
1186         if (smp_started == 0)
1187                 return (self);
1188         /*
1189          * Don't migrate a running thread from sched_switch().
1190          */
1191         if ((flags & SRQ_OURSELF) || !THREAD_CAN_MIGRATE(td))
1192                 return (ts->ts_cpu);
1193         /*
1194          * Prefer to run interrupt threads on the processors that generate
1195          * the interrupt.
1196          */
1197         pri = td->td_priority;
1198         if (td->td_priority <= PRI_MAX_ITHD && THREAD_CAN_SCHED(td, self) &&
1199             curthread->td_intr_nesting_level && ts->ts_cpu != self) {
1200                 SCHED_STAT_INC(pickcpu_intrbind);
1201                 ts->ts_cpu = self;
1202                 if (TDQ_CPU(self)->tdq_lowpri > pri) {
1203                         SCHED_STAT_INC(pickcpu_affinity);
1204                         return (ts->ts_cpu);
1205                 }
1206         }
1207         /*
1208          * If the thread can run on the last cpu and the affinity has not
1209          * expired or it is idle run it there.
1210          */
1211         tdq = TDQ_CPU(ts->ts_cpu);
1212         cg = tdq->tdq_cg;
1213         if (THREAD_CAN_SCHED(td, ts->ts_cpu) &&
1214             tdq->tdq_lowpri >= PRI_MIN_IDLE &&
1215             SCHED_AFFINITY(ts, CG_SHARE_L2)) {
1216                 if (cg->cg_flags & CG_FLAG_THREAD) {
1217                         CPUSET_FOREACH(cpu, cg->cg_mask) {
1218                                 if (TDQ_CPU(cpu)->tdq_lowpri < PRI_MIN_IDLE)
1219                                         break;
1220                         }
1221                 } else
1222                         cpu = INT_MAX;
1223                 if (cpu > mp_maxid) {
1224                         SCHED_STAT_INC(pickcpu_idle_affinity);
1225                         return (ts->ts_cpu);
1226                 }
1227         }
1228         /*
1229          * Search for the last level cache CPU group in the tree.
1230          * Skip caches with expired affinity time and SMT groups.
1231          * Affinity to higher level caches will be handled less aggressively.
1232          */
1233         for (ccg = NULL; cg != NULL; cg = cg->cg_parent) {
1234                 if (cg->cg_flags & CG_FLAG_THREAD)
1235                         continue;
1236                 if (!SCHED_AFFINITY(ts, cg->cg_level))
1237                         continue;
1238                 ccg = cg;
1239         }
1240         if (ccg != NULL)
1241                 cg = ccg;
1242         cpu = -1;
1243         /* Search the group for the less loaded idle CPU we can run now. */
1244         mask = td->td_cpuset->cs_mask;
1245         if (cg != NULL && cg != cpu_top &&
1246             CPU_CMP(&cg->cg_mask, &cpu_top->cg_mask) != 0)
1247                 cpu = sched_lowest(cg, mask, max(pri, PRI_MAX_TIMESHARE),
1248                     INT_MAX, ts->ts_cpu);
1249         /* Search globally for the less loaded CPU we can run now. */
1250         if (cpu == -1)
1251                 cpu = sched_lowest(cpu_top, mask, pri, INT_MAX, ts->ts_cpu);
1252         /* Search globally for the less loaded CPU. */
1253         if (cpu == -1)
1254                 cpu = sched_lowest(cpu_top, mask, -1, INT_MAX, ts->ts_cpu);
1255         KASSERT(cpu != -1, ("sched_pickcpu: Failed to find a cpu."));
1256         /*
1257          * Compare the lowest loaded cpu to current cpu.
1258          */
1259         if (THREAD_CAN_SCHED(td, self) && TDQ_CPU(self)->tdq_lowpri > pri &&
1260             TDQ_CPU(cpu)->tdq_lowpri < PRI_MIN_IDLE &&
1261             TDQ_CPU(self)->tdq_load <= TDQ_CPU(cpu)->tdq_load + 1) {
1262                 SCHED_STAT_INC(pickcpu_local);
1263                 cpu = self;
1264         } else
1265                 SCHED_STAT_INC(pickcpu_lowest);
1266         if (cpu != ts->ts_cpu)
1267                 SCHED_STAT_INC(pickcpu_migration);
1268         return (cpu);
1269 }
1270 #endif
1271
1272 /*
1273  * Pick the highest priority task we have and return it.
1274  */
1275 static struct thread *
1276 tdq_choose(struct tdq *tdq)
1277 {
1278         struct thread *td;
1279
1280         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
1281         td = runq_choose(&tdq->tdq_realtime);
1282         if (td != NULL)
1283                 return (td);
1284         td = runq_choose_from(&tdq->tdq_timeshare, tdq->tdq_ridx);
1285         if (td != NULL) {
1286                 KASSERT(td->td_priority >= PRI_MIN_BATCH,
1287                     ("tdq_choose: Invalid priority on timeshare queue %d",
1288                     td->td_priority));
1289                 return (td);
1290         }
1291         td = runq_choose(&tdq->tdq_idle);
1292         if (td != NULL) {
1293                 KASSERT(td->td_priority >= PRI_MIN_IDLE,
1294                     ("tdq_choose: Invalid priority on idle queue %d",
1295                     td->td_priority));
1296                 return (td);
1297         }
1298
1299         return (NULL);
1300 }
1301
1302 /*
1303  * Initialize a thread queue.
1304  */
1305 static void
1306 tdq_setup(struct tdq *tdq)
1307 {
1308
1309         if (bootverbose)
1310                 printf("ULE: setup cpu %d\n", TDQ_ID(tdq));
1311         runq_init(&tdq->tdq_realtime);
1312         runq_init(&tdq->tdq_timeshare);
1313         runq_init(&tdq->tdq_idle);
1314         snprintf(tdq->tdq_name, sizeof(tdq->tdq_name),
1315             "sched lock %d", (int)TDQ_ID(tdq));
1316         mtx_init(&tdq->tdq_lock, tdq->tdq_name, "sched lock",
1317             MTX_SPIN | MTX_RECURSE);
1318 #ifdef KTR
1319         snprintf(tdq->tdq_loadname, sizeof(tdq->tdq_loadname),
1320             "CPU %d load", (int)TDQ_ID(tdq));
1321 #endif
1322 }
1323
1324 #ifdef SMP
1325 static void
1326 sched_setup_smp(void)
1327 {
1328         struct tdq *tdq;
1329         int i;
1330
1331         cpu_top = smp_topo();
1332         CPU_FOREACH(i) {
1333                 tdq = TDQ_CPU(i);
1334                 tdq_setup(tdq);
1335                 tdq->tdq_cg = smp_topo_find(cpu_top, i);
1336                 if (tdq->tdq_cg == NULL)
1337                         panic("Can't find cpu group for %d\n", i);
1338         }
1339         balance_tdq = TDQ_SELF();
1340         sched_balance();
1341 }
1342 #endif
1343
1344 /*
1345  * Setup the thread queues and initialize the topology based on MD
1346  * information.
1347  */
1348 static void
1349 sched_setup(void *dummy)
1350 {
1351         struct tdq *tdq;
1352
1353         tdq = TDQ_SELF();
1354 #ifdef SMP
1355         sched_setup_smp();
1356 #else
1357         tdq_setup(tdq);
1358 #endif
1359         /*
1360          * To avoid divide-by-zero, we set realstathz a dummy value
1361          * in case which sched_clock() called before sched_initticks().
1362          */
1363         realstathz = hz;
1364         sched_slice = (realstathz/10);  /* ~100ms */
1365         tickincr = 1 << SCHED_TICK_SHIFT;
1366
1367         /* Add thread0's load since it's running. */
1368         TDQ_LOCK(tdq);
1369         thread0.td_lock = TDQ_LOCKPTR(TDQ_SELF());
1370         tdq_load_add(tdq, &thread0);
1371         tdq->tdq_lowpri = thread0.td_priority;
1372         TDQ_UNLOCK(tdq);
1373 }
1374
1375 /*
1376  * This routine determines the tickincr after stathz and hz are setup.
1377  */
1378 /* ARGSUSED */
1379 static void
1380 sched_initticks(void *dummy)
1381 {
1382         int incr;
1383
1384         realstathz = stathz ? stathz : hz;
1385         sched_slice = (realstathz/10);  /* ~100ms */
1386
1387         /*
1388          * tickincr is shifted out by 10 to avoid rounding errors due to
1389          * hz not being evenly divisible by stathz on all platforms.
1390          */
1391         incr = (hz << SCHED_TICK_SHIFT) / realstathz;
1392         /*
1393          * This does not work for values of stathz that are more than
1394          * 1 << SCHED_TICK_SHIFT * hz.  In practice this does not happen.
1395          */
1396         if (incr == 0)
1397                 incr = 1;
1398         tickincr = incr;
1399 #ifdef SMP
1400         /*
1401          * Set the default balance interval now that we know
1402          * what realstathz is.
1403          */
1404         balance_interval = realstathz;
1405         /*
1406          * Set steal thresh to roughly log2(mp_ncpu) but no greater than 4.
1407          * This prevents excess thrashing on large machines and excess idle
1408          * on smaller machines.
1409          */
1410         steal_thresh = min(fls(mp_ncpus) - 1, 3);
1411         affinity = SCHED_AFFINITY_DEFAULT;
1412 #endif
1413 }
1414
1415
1416 /*
1417  * This is the core of the interactivity algorithm.  Determines a score based
1418  * on past behavior.  It is the ratio of sleep time to run time scaled to
1419  * a [0, 100] integer.  This is the voluntary sleep time of a process, which
1420  * differs from the cpu usage because it does not account for time spent
1421  * waiting on a run-queue.  Would be prettier if we had floating point.
1422  */
1423 static int
1424 sched_interact_score(struct thread *td)
1425 {
1426         struct td_sched *ts;
1427         int div;
1428
1429         ts = td->td_sched;
1430         /*
1431          * The score is only needed if this is likely to be an interactive
1432          * task.  Don't go through the expense of computing it if there's
1433          * no chance.
1434          */
1435         if (sched_interact <= SCHED_INTERACT_HALF &&
1436                 ts->ts_runtime >= ts->ts_slptime)
1437                         return (SCHED_INTERACT_HALF);
1438
1439         if (ts->ts_runtime > ts->ts_slptime) {
1440                 div = max(1, ts->ts_runtime / SCHED_INTERACT_HALF);
1441                 return (SCHED_INTERACT_HALF +
1442                     (SCHED_INTERACT_HALF - (ts->ts_slptime / div)));
1443         }
1444         if (ts->ts_slptime > ts->ts_runtime) {
1445                 div = max(1, ts->ts_slptime / SCHED_INTERACT_HALF);
1446                 return (ts->ts_runtime / div);
1447         }
1448         /* runtime == slptime */
1449         if (ts->ts_runtime)
1450                 return (SCHED_INTERACT_HALF);
1451
1452         /*
1453          * This can happen if slptime and runtime are 0.
1454          */
1455         return (0);
1456
1457 }
1458
1459 /*
1460  * Scale the scheduling priority according to the "interactivity" of this
1461  * process.
1462  */
1463 static void
1464 sched_priority(struct thread *td)
1465 {
1466         int score;
1467         int pri;
1468
1469         if (PRI_BASE(td->td_pri_class) != PRI_TIMESHARE)
1470                 return;
1471         /*
1472          * If the score is interactive we place the thread in the realtime
1473          * queue with a priority that is less than kernel and interrupt
1474          * priorities.  These threads are not subject to nice restrictions.
1475          *
1476          * Scores greater than this are placed on the normal timeshare queue
1477          * where the priority is partially decided by the most recent cpu
1478          * utilization and the rest is decided by nice value.
1479          *
1480          * The nice value of the process has a linear effect on the calculated
1481          * score.  Negative nice values make it easier for a thread to be
1482          * considered interactive.
1483          */
1484         score = imax(0, sched_interact_score(td) + td->td_proc->p_nice);
1485         if (score < sched_interact) {
1486                 pri = PRI_MIN_INTERACT;
1487                 pri += ((PRI_MAX_INTERACT - PRI_MIN_INTERACT + 1) /
1488                     sched_interact) * score;
1489                 KASSERT(pri >= PRI_MIN_INTERACT && pri <= PRI_MAX_INTERACT,
1490                     ("sched_priority: invalid interactive priority %d score %d",
1491                     pri, score));
1492         } else {
1493                 pri = SCHED_PRI_MIN;
1494                 if (td->td_sched->ts_ticks)
1495                         pri += min(SCHED_PRI_TICKS(td->td_sched),
1496                             SCHED_PRI_RANGE);
1497                 pri += SCHED_PRI_NICE(td->td_proc->p_nice);
1498                 KASSERT(pri >= PRI_MIN_BATCH && pri <= PRI_MAX_BATCH,
1499                     ("sched_priority: invalid priority %d: nice %d, "
1500                     "ticks %d ftick %d ltick %d tick pri %d",
1501                     pri, td->td_proc->p_nice, td->td_sched->ts_ticks,
1502                     td->td_sched->ts_ftick, td->td_sched->ts_ltick,
1503                     SCHED_PRI_TICKS(td->td_sched)));
1504         }
1505         sched_user_prio(td, pri);
1506
1507         return;
1508 }
1509
1510 /*
1511  * This routine enforces a maximum limit on the amount of scheduling history
1512  * kept.  It is called after either the slptime or runtime is adjusted.  This
1513  * function is ugly due to integer math.
1514  */
1515 static void
1516 sched_interact_update(struct thread *td)
1517 {
1518         struct td_sched *ts;
1519         u_int sum;
1520
1521         ts = td->td_sched;
1522         sum = ts->ts_runtime + ts->ts_slptime;
1523         if (sum < SCHED_SLP_RUN_MAX)
1524                 return;
1525         /*
1526          * This only happens from two places:
1527          * 1) We have added an unusual amount of run time from fork_exit.
1528          * 2) We have added an unusual amount of sleep time from sched_sleep().
1529          */
1530         if (sum > SCHED_SLP_RUN_MAX * 2) {
1531                 if (ts->ts_runtime > ts->ts_slptime) {
1532                         ts->ts_runtime = SCHED_SLP_RUN_MAX;
1533                         ts->ts_slptime = 1;
1534                 } else {
1535                         ts->ts_slptime = SCHED_SLP_RUN_MAX;
1536                         ts->ts_runtime = 1;
1537                 }
1538                 return;
1539         }
1540         /*
1541          * If we have exceeded by more than 1/5th then the algorithm below
1542          * will not bring us back into range.  Dividing by two here forces
1543          * us into the range of [4/5 * SCHED_INTERACT_MAX, SCHED_INTERACT_MAX]
1544          */
1545         if (sum > (SCHED_SLP_RUN_MAX / 5) * 6) {
1546                 ts->ts_runtime /= 2;
1547                 ts->ts_slptime /= 2;
1548                 return;
1549         }
1550         ts->ts_runtime = (ts->ts_runtime / 5) * 4;
1551         ts->ts_slptime = (ts->ts_slptime / 5) * 4;
1552 }
1553
1554 /*
1555  * Scale back the interactivity history when a child thread is created.  The
1556  * history is inherited from the parent but the thread may behave totally
1557  * differently.  For example, a shell spawning a compiler process.  We want
1558  * to learn that the compiler is behaving badly very quickly.
1559  */
1560 static void
1561 sched_interact_fork(struct thread *td)
1562 {
1563         int ratio;
1564         int sum;
1565
1566         sum = td->td_sched->ts_runtime + td->td_sched->ts_slptime;
1567         if (sum > SCHED_SLP_RUN_FORK) {
1568                 ratio = sum / SCHED_SLP_RUN_FORK;
1569                 td->td_sched->ts_runtime /= ratio;
1570                 td->td_sched->ts_slptime /= ratio;
1571         }
1572 }
1573
1574 /*
1575  * Called from proc0_init() to setup the scheduler fields.
1576  */
1577 void
1578 schedinit(void)
1579 {
1580
1581         /*
1582          * Set up the scheduler specific parts of proc0.
1583          */
1584         proc0.p_sched = NULL; /* XXX */
1585         thread0.td_sched = &td_sched0;
1586         td_sched0.ts_ltick = ticks;
1587         td_sched0.ts_ftick = ticks;
1588         td_sched0.ts_slice = sched_slice;
1589 }
1590
1591 /*
1592  * This is only somewhat accurate since given many processes of the same
1593  * priority they will switch when their slices run out, which will be
1594  * at most sched_slice stathz ticks.
1595  */
1596 int
1597 sched_rr_interval(void)
1598 {
1599
1600         /* Convert sched_slice to hz */
1601         return (hz/(realstathz/sched_slice));
1602 }
1603
1604 /*
1605  * Update the percent cpu tracking information when it is requested or
1606  * the total history exceeds the maximum.  We keep a sliding history of
1607  * tick counts that slowly decays.  This is less precise than the 4BSD
1608  * mechanism since it happens with less regular and frequent events.
1609  */
1610 static void
1611 sched_pctcpu_update(struct td_sched *ts, int run)
1612 {
1613         int t = ticks;
1614
1615         if (t - ts->ts_ltick >= SCHED_TICK_TARG) {
1616                 ts->ts_ticks = 0;
1617                 ts->ts_ftick = t - SCHED_TICK_TARG;
1618         } else if (t - ts->ts_ftick >= SCHED_TICK_MAX) {
1619                 ts->ts_ticks = (ts->ts_ticks / (ts->ts_ltick - ts->ts_ftick)) *
1620                     (ts->ts_ltick - (t - SCHED_TICK_TARG));
1621                 ts->ts_ftick = t - SCHED_TICK_TARG;
1622         }
1623         if (run)
1624                 ts->ts_ticks += (t - ts->ts_ltick) << SCHED_TICK_SHIFT;
1625         ts->ts_ltick = t;
1626 }
1627
1628 /*
1629  * Adjust the priority of a thread.  Move it to the appropriate run-queue
1630  * if necessary.  This is the back-end for several priority related
1631  * functions.
1632  */
1633 static void
1634 sched_thread_priority(struct thread *td, u_char prio)
1635 {
1636         struct td_sched *ts;
1637         struct tdq *tdq;
1638         int oldpri;
1639
1640         KTR_POINT3(KTR_SCHED, "thread", sched_tdname(td), "prio",
1641             "prio:%d", td->td_priority, "new prio:%d", prio,
1642             KTR_ATTR_LINKED, sched_tdname(curthread));
1643         SDT_PROBE3(sched, , , change_pri, td, td->td_proc, prio);
1644         if (td != curthread && prio > td->td_priority) {
1645                 KTR_POINT3(KTR_SCHED, "thread", sched_tdname(curthread),
1646                     "lend prio", "prio:%d", td->td_priority, "new prio:%d",
1647                     prio, KTR_ATTR_LINKED, sched_tdname(td));
1648                 SDT_PROBE4(sched, , , lend_pri, td, td->td_proc, prio,
1649                     curthread);
1650         }
1651         ts = td->td_sched;
1652         THREAD_LOCK_ASSERT(td, MA_OWNED);
1653         if (td->td_priority == prio)
1654                 return;
1655         /*
1656          * If the priority has been elevated due to priority
1657          * propagation, we may have to move ourselves to a new
1658          * queue.  This could be optimized to not re-add in some
1659          * cases.
1660          */
1661         if (TD_ON_RUNQ(td) && prio < td->td_priority) {
1662                 sched_rem(td);
1663                 td->td_priority = prio;
1664                 sched_add(td, SRQ_BORROWING);
1665                 return;
1666         }
1667         /*
1668          * If the thread is currently running we may have to adjust the lowpri
1669          * information so other cpus are aware of our current priority.
1670          */
1671         if (TD_IS_RUNNING(td)) {
1672                 tdq = TDQ_CPU(ts->ts_cpu);
1673                 oldpri = td->td_priority;
1674                 td->td_priority = prio;
1675                 if (prio < tdq->tdq_lowpri)
1676                         tdq->tdq_lowpri = prio;
1677                 else if (tdq->tdq_lowpri == oldpri)
1678                         tdq_setlowpri(tdq, td);
1679                 return;
1680         }
1681         td->td_priority = prio;
1682 }
1683
1684 /*
1685  * Update a thread's priority when it is lent another thread's
1686  * priority.
1687  */
1688 void
1689 sched_lend_prio(struct thread *td, u_char prio)
1690 {
1691
1692         td->td_flags |= TDF_BORROWING;
1693         sched_thread_priority(td, prio);
1694 }
1695
1696 /*
1697  * Restore a thread's priority when priority propagation is
1698  * over.  The prio argument is the minimum priority the thread
1699  * needs to have to satisfy other possible priority lending
1700  * requests.  If the thread's regular priority is less
1701  * important than prio, the thread will keep a priority boost
1702  * of prio.
1703  */
1704 void
1705 sched_unlend_prio(struct thread *td, u_char prio)
1706 {
1707         u_char base_pri;
1708
1709         if (td->td_base_pri >= PRI_MIN_TIMESHARE &&
1710             td->td_base_pri <= PRI_MAX_TIMESHARE)
1711                 base_pri = td->td_user_pri;
1712         else
1713                 base_pri = td->td_base_pri;
1714         if (prio >= base_pri) {
1715                 td->td_flags &= ~TDF_BORROWING;
1716                 sched_thread_priority(td, base_pri);
1717         } else
1718                 sched_lend_prio(td, prio);
1719 }
1720
1721 /*
1722  * Standard entry for setting the priority to an absolute value.
1723  */
1724 void
1725 sched_prio(struct thread *td, u_char prio)
1726 {
1727         u_char oldprio;
1728
1729         /* First, update the base priority. */
1730         td->td_base_pri = prio;
1731
1732         /*
1733          * If the thread is borrowing another thread's priority, don't
1734          * ever lower the priority.
1735          */
1736         if (td->td_flags & TDF_BORROWING && td->td_priority < prio)
1737                 return;
1738
1739         /* Change the real priority. */
1740         oldprio = td->td_priority;
1741         sched_thread_priority(td, prio);
1742
1743         /*
1744          * If the thread is on a turnstile, then let the turnstile update
1745          * its state.
1746          */
1747         if (TD_ON_LOCK(td) && oldprio != prio)
1748                 turnstile_adjust(td, oldprio);
1749 }
1750
1751 /*
1752  * Set the base user priority, does not effect current running priority.
1753  */
1754 void
1755 sched_user_prio(struct thread *td, u_char prio)
1756 {
1757
1758         td->td_base_user_pri = prio;
1759         if (td->td_lend_user_pri <= prio)
1760                 return;
1761         td->td_user_pri = prio;
1762 }
1763
1764 void
1765 sched_lend_user_prio(struct thread *td, u_char prio)
1766 {
1767
1768         THREAD_LOCK_ASSERT(td, MA_OWNED);
1769         td->td_lend_user_pri = prio;
1770         td->td_user_pri = min(prio, td->td_base_user_pri);
1771         if (td->td_priority > td->td_user_pri)
1772                 sched_prio(td, td->td_user_pri);
1773         else if (td->td_priority != td->td_user_pri)
1774                 td->td_flags |= TDF_NEEDRESCHED;
1775 }
1776
1777 /*
1778  * Handle migration from sched_switch().  This happens only for
1779  * cpu binding.
1780  */
1781 static struct mtx *
1782 sched_switch_migrate(struct tdq *tdq, struct thread *td, int flags)
1783 {
1784         struct tdq *tdn;
1785
1786         tdn = TDQ_CPU(td->td_sched->ts_cpu);
1787 #ifdef SMP
1788         tdq_load_rem(tdq, td);
1789         /*
1790          * Do the lock dance required to avoid LOR.  We grab an extra
1791          * spinlock nesting to prevent preemption while we're
1792          * not holding either run-queue lock.
1793          */
1794         spinlock_enter();
1795         thread_lock_block(td);  /* This releases the lock on tdq. */
1796
1797         /*
1798          * Acquire both run-queue locks before placing the thread on the new
1799          * run-queue to avoid deadlocks created by placing a thread with a
1800          * blocked lock on the run-queue of a remote processor.  The deadlock
1801          * occurs when a third processor attempts to lock the two queues in
1802          * question while the target processor is spinning with its own
1803          * run-queue lock held while waiting for the blocked lock to clear.
1804          */
1805         tdq_lock_pair(tdn, tdq);
1806         tdq_add(tdn, td, flags);
1807         tdq_notify(tdn, td);
1808         TDQ_UNLOCK(tdn);
1809         spinlock_exit();
1810 #endif
1811         return (TDQ_LOCKPTR(tdn));
1812 }
1813
1814 /*
1815  * Variadic version of thread_lock_unblock() that does not assume td_lock
1816  * is blocked.
1817  */
1818 static inline void
1819 thread_unblock_switch(struct thread *td, struct mtx *mtx)
1820 {
1821         atomic_store_rel_ptr((volatile uintptr_t *)&td->td_lock,
1822             (uintptr_t)mtx);
1823 }
1824
1825 /*
1826  * Switch threads.  This function has to handle threads coming in while
1827  * blocked for some reason, running, or idle.  It also must deal with
1828  * migrating a thread from one queue to another as running threads may
1829  * be assigned elsewhere via binding.
1830  */
1831 void
1832 sched_switch(struct thread *td, struct thread *newtd, int flags)
1833 {
1834         struct tdq *tdq;
1835         struct td_sched *ts;
1836         struct mtx *mtx;
1837         int srqflag;
1838         int cpuid;
1839
1840         THREAD_LOCK_ASSERT(td, MA_OWNED);
1841         KASSERT(newtd == NULL, ("sched_switch: Unsupported newtd argument"));
1842
1843         cpuid = PCPU_GET(cpuid);
1844         tdq = TDQ_CPU(cpuid);
1845         ts = td->td_sched;
1846         mtx = td->td_lock;
1847         sched_pctcpu_update(ts, 1);
1848         ts->ts_rltick = ticks;
1849         td->td_lastcpu = td->td_oncpu;
1850         td->td_oncpu = NOCPU;
1851         if (!(flags & SW_PREEMPT))
1852                 td->td_flags &= ~TDF_NEEDRESCHED;
1853         td->td_owepreempt = 0;
1854         tdq->tdq_switchcnt++;
1855         /*
1856          * The lock pointer in an idle thread should never change.  Reset it
1857          * to CAN_RUN as well.
1858          */
1859         if (TD_IS_IDLETHREAD(td)) {
1860                 MPASS(td->td_lock == TDQ_LOCKPTR(tdq));
1861                 TD_SET_CAN_RUN(td);
1862         } else if (TD_IS_RUNNING(td)) {
1863                 MPASS(td->td_lock == TDQ_LOCKPTR(tdq));
1864                 srqflag = (flags & SW_PREEMPT) ?
1865                     SRQ_OURSELF|SRQ_YIELDING|SRQ_PREEMPTED :
1866                     SRQ_OURSELF|SRQ_YIELDING;
1867 #ifdef SMP
1868                 if (THREAD_CAN_MIGRATE(td) && !THREAD_CAN_SCHED(td, ts->ts_cpu))
1869                         ts->ts_cpu = sched_pickcpu(td, 0);
1870 #endif
1871                 if (ts->ts_cpu == cpuid)
1872                         tdq_runq_add(tdq, td, srqflag);
1873                 else {
1874                         KASSERT(THREAD_CAN_MIGRATE(td) ||
1875                             (ts->ts_flags & TSF_BOUND) != 0,
1876                             ("Thread %p shouldn't migrate", td));
1877                         mtx = sched_switch_migrate(tdq, td, srqflag);
1878                 }
1879         } else {
1880                 /* This thread must be going to sleep. */
1881                 TDQ_LOCK(tdq);
1882                 mtx = thread_lock_block(td);
1883                 tdq_load_rem(tdq, td);
1884         }
1885         /*
1886          * We enter here with the thread blocked and assigned to the
1887          * appropriate cpu run-queue or sleep-queue and with the current
1888          * thread-queue locked.
1889          */
1890         TDQ_LOCK_ASSERT(tdq, MA_OWNED | MA_NOTRECURSED);
1891         newtd = choosethread();
1892         /*
1893          * Call the MD code to switch contexts if necessary.
1894          */
1895         if (td != newtd) {
1896 #ifdef  HWPMC_HOOKS
1897                 if (PMC_PROC_IS_USING_PMCS(td->td_proc))
1898                         PMC_SWITCH_CONTEXT(td, PMC_FN_CSW_OUT);
1899 #endif
1900                 SDT_PROBE2(sched, , , off_cpu, td, td->td_proc);
1901                 lock_profile_release_lock(&TDQ_LOCKPTR(tdq)->lock_object);
1902                 TDQ_LOCKPTR(tdq)->mtx_lock = (uintptr_t)newtd;
1903                 sched_pctcpu_update(newtd->td_sched, 0);
1904
1905 #ifdef KDTRACE_HOOKS
1906                 /*
1907                  * If DTrace has set the active vtime enum to anything
1908                  * other than INACTIVE (0), then it should have set the
1909                  * function to call.
1910                  */
1911                 if (dtrace_vtime_active)
1912                         (*dtrace_vtime_switch_func)(newtd);
1913 #endif
1914
1915                 cpu_switch(td, newtd, mtx);
1916                 /*
1917                  * We may return from cpu_switch on a different cpu.  However,
1918                  * we always return with td_lock pointing to the current cpu's
1919                  * run queue lock.
1920                  */
1921                 cpuid = PCPU_GET(cpuid);
1922                 tdq = TDQ_CPU(cpuid);
1923                 lock_profile_obtain_lock_success(
1924                     &TDQ_LOCKPTR(tdq)->lock_object, 0, 0, __FILE__, __LINE__);
1925
1926                 SDT_PROBE0(sched, , , on_cpu);
1927 #ifdef  HWPMC_HOOKS
1928                 if (PMC_PROC_IS_USING_PMCS(td->td_proc))
1929                         PMC_SWITCH_CONTEXT(td, PMC_FN_CSW_IN);
1930 #endif
1931         } else {
1932                 thread_unblock_switch(td, mtx);
1933                 SDT_PROBE0(sched, , , remain_cpu);
1934         }
1935         /*
1936          * Assert that all went well and return.
1937          */
1938         TDQ_LOCK_ASSERT(tdq, MA_OWNED|MA_NOTRECURSED);
1939         MPASS(td->td_lock == TDQ_LOCKPTR(tdq));
1940         td->td_oncpu = cpuid;
1941 }
1942
1943 /*
1944  * Adjust thread priorities as a result of a nice request.
1945  */
1946 void
1947 sched_nice(struct proc *p, int nice)
1948 {
1949         struct thread *td;
1950
1951         PROC_LOCK_ASSERT(p, MA_OWNED);
1952
1953         p->p_nice = nice;
1954         FOREACH_THREAD_IN_PROC(p, td) {
1955                 thread_lock(td);
1956                 sched_priority(td);
1957                 sched_prio(td, td->td_base_user_pri);
1958                 thread_unlock(td);
1959         }
1960 }
1961
1962 /*
1963  * Record the sleep time for the interactivity scorer.
1964  */
1965 void
1966 sched_sleep(struct thread *td, int prio)
1967 {
1968
1969         THREAD_LOCK_ASSERT(td, MA_OWNED);
1970
1971         td->td_slptick = ticks;
1972         if (TD_IS_SUSPENDED(td) || prio >= PSOCK)
1973                 td->td_flags |= TDF_CANSWAP;
1974         if (PRI_BASE(td->td_pri_class) != PRI_TIMESHARE)
1975                 return;
1976         if (static_boost == 1 && prio)
1977                 sched_prio(td, prio);
1978         else if (static_boost && td->td_priority > static_boost)
1979                 sched_prio(td, static_boost);
1980 }
1981
1982 /*
1983  * Schedule a thread to resume execution and record how long it voluntarily
1984  * slept.  We also update the pctcpu, interactivity, and priority.
1985  */
1986 void
1987 sched_wakeup(struct thread *td)
1988 {
1989         struct td_sched *ts;
1990         int slptick;
1991
1992         THREAD_LOCK_ASSERT(td, MA_OWNED);
1993         ts = td->td_sched;
1994         td->td_flags &= ~TDF_CANSWAP;
1995         /*
1996          * If we slept for more than a tick update our interactivity and
1997          * priority.
1998          */
1999         slptick = td->td_slptick;
2000         td->td_slptick = 0;
2001         if (slptick && slptick != ticks) {
2002                 ts->ts_slptime += (ticks - slptick) << SCHED_TICK_SHIFT;
2003                 sched_interact_update(td);
2004                 sched_pctcpu_update(ts, 0);
2005         }
2006         /* Reset the slice value after we sleep. */
2007         ts->ts_slice = sched_slice;
2008         sched_add(td, SRQ_BORING);
2009 }
2010
2011 /*
2012  * Penalize the parent for creating a new child and initialize the child's
2013  * priority.
2014  */
2015 void
2016 sched_fork(struct thread *td, struct thread *child)
2017 {
2018         THREAD_LOCK_ASSERT(td, MA_OWNED);
2019         sched_pctcpu_update(td->td_sched, 1);
2020         sched_fork_thread(td, child);
2021         /*
2022          * Penalize the parent and child for forking.
2023          */
2024         sched_interact_fork(child);
2025         sched_priority(child);
2026         td->td_sched->ts_runtime += tickincr;
2027         sched_interact_update(td);
2028         sched_priority(td);
2029 }
2030
2031 /*
2032  * Fork a new thread, may be within the same process.
2033  */
2034 void
2035 sched_fork_thread(struct thread *td, struct thread *child)
2036 {
2037         struct td_sched *ts;
2038         struct td_sched *ts2;
2039
2040         THREAD_LOCK_ASSERT(td, MA_OWNED);
2041         /*
2042          * Initialize child.
2043          */
2044         ts = td->td_sched;
2045         ts2 = child->td_sched;
2046         child->td_lock = TDQ_LOCKPTR(TDQ_SELF());
2047         child->td_cpuset = cpuset_ref(td->td_cpuset);
2048         ts2->ts_cpu = ts->ts_cpu;
2049         ts2->ts_flags = 0;
2050         /*
2051          * Grab our parents cpu estimation information.
2052          */
2053         ts2->ts_ticks = ts->ts_ticks;
2054         ts2->ts_ltick = ts->ts_ltick;
2055         ts2->ts_ftick = ts->ts_ftick;
2056         /*
2057          * Do not inherit any borrowed priority from the parent.
2058          */
2059         child->td_priority = child->td_base_pri;
2060         /*
2061          * And update interactivity score.
2062          */
2063         ts2->ts_slptime = ts->ts_slptime;
2064         ts2->ts_runtime = ts->ts_runtime;
2065         ts2->ts_slice = 1;      /* Attempt to quickly learn interactivity. */
2066 #ifdef KTR
2067         bzero(ts2->ts_name, sizeof(ts2->ts_name));
2068 #endif
2069 }
2070
2071 /*
2072  * Adjust the priority class of a thread.
2073  */
2074 void
2075 sched_class(struct thread *td, int class)
2076 {
2077
2078         THREAD_LOCK_ASSERT(td, MA_OWNED);
2079         if (td->td_pri_class == class)
2080                 return;
2081         td->td_pri_class = class;
2082 }
2083
2084 /*
2085  * Return some of the child's priority and interactivity to the parent.
2086  */
2087 void
2088 sched_exit(struct proc *p, struct thread *child)
2089 {
2090         struct thread *td;
2091
2092         KTR_STATE1(KTR_SCHED, "thread", sched_tdname(child), "proc exit",
2093             "prio:%d", child->td_priority);
2094         PROC_LOCK_ASSERT(p, MA_OWNED);
2095         td = FIRST_THREAD_IN_PROC(p);
2096         sched_exit_thread(td, child);
2097 }
2098
2099 /*
2100  * Penalize another thread for the time spent on this one.  This helps to
2101  * worsen the priority and interactivity of processes which schedule batch
2102  * jobs such as make.  This has little effect on the make process itself but
2103  * causes new processes spawned by it to receive worse scores immediately.
2104  */
2105 void
2106 sched_exit_thread(struct thread *td, struct thread *child)
2107 {
2108
2109         KTR_STATE1(KTR_SCHED, "thread", sched_tdname(child), "thread exit",
2110             "prio:%d", child->td_priority);
2111         /*
2112          * Give the child's runtime to the parent without returning the
2113          * sleep time as a penalty to the parent.  This causes shells that
2114          * launch expensive things to mark their children as expensive.
2115          */
2116         thread_lock(td);
2117         td->td_sched->ts_runtime += child->td_sched->ts_runtime;
2118         sched_interact_update(td);
2119         sched_priority(td);
2120         thread_unlock(td);
2121 }
2122
2123 void
2124 sched_preempt(struct thread *td)
2125 {
2126         struct tdq *tdq;
2127
2128         SDT_PROBE2(sched, , , surrender, td, td->td_proc);
2129
2130         thread_lock(td);
2131         tdq = TDQ_SELF();
2132         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
2133         tdq->tdq_ipipending = 0;
2134         if (td->td_priority > tdq->tdq_lowpri) {
2135                 int flags;
2136
2137                 flags = SW_INVOL | SW_PREEMPT;
2138                 if (td->td_critnest > 1)
2139                         td->td_owepreempt = 1;
2140                 else if (TD_IS_IDLETHREAD(td))
2141                         mi_switch(flags | SWT_REMOTEWAKEIDLE, NULL);
2142                 else
2143                         mi_switch(flags | SWT_REMOTEPREEMPT, NULL);
2144         }
2145         thread_unlock(td);
2146 }
2147
2148 /*
2149  * Fix priorities on return to user-space.  Priorities may be elevated due
2150  * to static priorities in msleep() or similar.
2151  */
2152 void
2153 sched_userret(struct thread *td)
2154 {
2155         /*
2156          * XXX we cheat slightly on the locking here to avoid locking in
2157          * the usual case.  Setting td_priority here is essentially an
2158          * incomplete workaround for not setting it properly elsewhere.
2159          * Now that some interrupt handlers are threads, not setting it
2160          * properly elsewhere can clobber it in the window between setting
2161          * it here and returning to user mode, so don't waste time setting
2162          * it perfectly here.
2163          */
2164         KASSERT((td->td_flags & TDF_BORROWING) == 0,
2165             ("thread with borrowed priority returning to userland"));
2166         if (td->td_priority != td->td_user_pri) {
2167                 thread_lock(td);
2168                 td->td_priority = td->td_user_pri;
2169                 td->td_base_pri = td->td_user_pri;
2170                 tdq_setlowpri(TDQ_SELF(), td);
2171                 thread_unlock(td);
2172         }
2173 }
2174
2175 /*
2176  * Handle a stathz tick.  This is really only relevant for timeshare
2177  * threads.
2178  */
2179 void
2180 sched_clock(struct thread *td)
2181 {
2182         struct tdq *tdq;
2183         struct td_sched *ts;
2184
2185         THREAD_LOCK_ASSERT(td, MA_OWNED);
2186         tdq = TDQ_SELF();
2187 #ifdef SMP
2188         /*
2189          * We run the long term load balancer infrequently on the first cpu.
2190          */
2191         if (balance_tdq == tdq) {
2192                 if (balance_ticks && --balance_ticks == 0)
2193                         sched_balance();
2194         }
2195 #endif
2196         /*
2197          * Save the old switch count so we have a record of the last ticks
2198          * activity.   Initialize the new switch count based on our load.
2199          * If there is some activity seed it to reflect that.
2200          */
2201         tdq->tdq_oldswitchcnt = tdq->tdq_switchcnt;
2202         tdq->tdq_switchcnt = tdq->tdq_load;
2203         /*
2204          * Advance the insert index once for each tick to ensure that all
2205          * threads get a chance to run.
2206          */
2207         if (tdq->tdq_idx == tdq->tdq_ridx) {
2208                 tdq->tdq_idx = (tdq->tdq_idx + 1) % RQ_NQS;
2209                 if (TAILQ_EMPTY(&tdq->tdq_timeshare.rq_queues[tdq->tdq_ridx]))
2210                         tdq->tdq_ridx = tdq->tdq_idx;
2211         }
2212         ts = td->td_sched;
2213         sched_pctcpu_update(ts, 1);
2214         if (td->td_pri_class & PRI_FIFO_BIT)
2215                 return;
2216         if (PRI_BASE(td->td_pri_class) == PRI_TIMESHARE) {
2217                 /*
2218                  * We used a tick; charge it to the thread so
2219                  * that we can compute our interactivity.
2220                  */
2221                 td->td_sched->ts_runtime += tickincr;
2222                 sched_interact_update(td);
2223                 sched_priority(td);
2224         }
2225         /*
2226          * We used up one time slice.
2227          */
2228         if (--ts->ts_slice > 0)
2229                 return;
2230         /*
2231          * We're out of time, force a requeue at userret().
2232          */
2233         ts->ts_slice = sched_slice;
2234         td->td_flags |= TDF_NEEDRESCHED;
2235 }
2236
2237 /*
2238  * Called once per hz tick.
2239  */
2240 void
2241 sched_tick(int cnt)
2242 {
2243
2244 }
2245
2246 /*
2247  * Return whether the current CPU has runnable tasks.  Used for in-kernel
2248  * cooperative idle threads.
2249  */
2250 int
2251 sched_runnable(void)
2252 {
2253         struct tdq *tdq;
2254         int load;
2255
2256         load = 1;
2257
2258         tdq = TDQ_SELF();
2259         if ((curthread->td_flags & TDF_IDLETD) != 0) {
2260                 if (tdq->tdq_load > 0)
2261                         goto out;
2262         } else
2263                 if (tdq->tdq_load - 1 > 0)
2264                         goto out;
2265         load = 0;
2266 out:
2267         return (load);
2268 }
2269
2270 /*
2271  * Choose the highest priority thread to run.  The thread is removed from
2272  * the run-queue while running however the load remains.  For SMP we set
2273  * the tdq in the global idle bitmask if it idles here.
2274  */
2275 struct thread *
2276 sched_choose(void)
2277 {
2278         struct thread *td;
2279         struct tdq *tdq;
2280
2281         tdq = TDQ_SELF();
2282         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
2283         td = tdq_choose(tdq);
2284         if (td) {
2285                 tdq_runq_rem(tdq, td);
2286                 tdq->tdq_lowpri = td->td_priority;
2287                 return (td);
2288         }
2289         tdq->tdq_lowpri = PRI_MAX_IDLE;
2290         return (PCPU_GET(idlethread));
2291 }
2292
2293 /*
2294  * Set owepreempt if necessary.  Preemption never happens directly in ULE,
2295  * we always request it once we exit a critical section.
2296  */
2297 static inline void
2298 sched_setpreempt(struct thread *td)
2299 {
2300         struct thread *ctd;
2301         int cpri;
2302         int pri;
2303
2304         THREAD_LOCK_ASSERT(curthread, MA_OWNED);
2305
2306         ctd = curthread;
2307         pri = td->td_priority;
2308         cpri = ctd->td_priority;
2309         if (pri < cpri)
2310                 ctd->td_flags |= TDF_NEEDRESCHED;
2311         if (panicstr != NULL || pri >= cpri || cold || TD_IS_INHIBITED(ctd))
2312                 return;
2313         if (!sched_shouldpreempt(pri, cpri, 0))
2314                 return;
2315         ctd->td_owepreempt = 1;
2316 }
2317
2318 /*
2319  * Add a thread to a thread queue.  Select the appropriate runq and add the
2320  * thread to it.  This is the internal function called when the tdq is
2321  * predetermined.
2322  */
2323 void
2324 tdq_add(struct tdq *tdq, struct thread *td, int flags)
2325 {
2326
2327         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
2328         KASSERT((td->td_inhibitors == 0),
2329             ("sched_add: trying to run inhibited thread"));
2330         KASSERT((TD_CAN_RUN(td) || TD_IS_RUNNING(td)),
2331             ("sched_add: bad thread state"));
2332         KASSERT(td->td_flags & TDF_INMEM,
2333             ("sched_add: thread swapped out"));
2334
2335         if (td->td_priority < tdq->tdq_lowpri)
2336                 tdq->tdq_lowpri = td->td_priority;
2337         tdq_runq_add(tdq, td, flags);
2338         tdq_load_add(tdq, td);
2339 }
2340
2341 /*
2342  * Select the target thread queue and add a thread to it.  Request
2343  * preemption or IPI a remote processor if required.
2344  */
2345 void
2346 sched_add(struct thread *td, int flags)
2347 {
2348         struct tdq *tdq;
2349 #ifdef SMP
2350         int cpu;
2351 #endif
2352
2353         KTR_STATE2(KTR_SCHED, "thread", sched_tdname(td), "runq add",
2354             "prio:%d", td->td_priority, KTR_ATTR_LINKED,
2355             sched_tdname(curthread));
2356         KTR_POINT1(KTR_SCHED, "thread", sched_tdname(curthread), "wokeup",
2357             KTR_ATTR_LINKED, sched_tdname(td));
2358         SDT_PROBE4(sched, , , enqueue, td, td->td_proc, NULL,
2359             flags & SRQ_PREEMPTED);
2360         THREAD_LOCK_ASSERT(td, MA_OWNED);
2361         /*
2362          * Recalculate the priority before we select the target cpu or
2363          * run-queue.
2364          */
2365         if (PRI_BASE(td->td_pri_class) == PRI_TIMESHARE)
2366                 sched_priority(td);
2367 #ifdef SMP
2368         /*
2369          * Pick the destination cpu and if it isn't ours transfer to the
2370          * target cpu.
2371          */
2372         cpu = sched_pickcpu(td, flags);
2373         tdq = sched_setcpu(td, cpu, flags);
2374         tdq_add(tdq, td, flags);
2375         if (cpu != PCPU_GET(cpuid)) {
2376                 tdq_notify(tdq, td);
2377                 return;
2378         }
2379 #else
2380         tdq = TDQ_SELF();
2381         TDQ_LOCK(tdq);
2382         /*
2383          * Now that the thread is moving to the run-queue, set the lock
2384          * to the scheduler's lock.
2385          */
2386         thread_lock_set(td, TDQ_LOCKPTR(tdq));
2387         tdq_add(tdq, td, flags);
2388 #endif
2389         if (!(flags & SRQ_YIELDING))
2390                 sched_setpreempt(td);
2391 }
2392
2393 /*
2394  * Remove a thread from a run-queue without running it.  This is used
2395  * when we're stealing a thread from a remote queue.  Otherwise all threads
2396  * exit by calling sched_exit_thread() and sched_throw() themselves.
2397  */
2398 void
2399 sched_rem(struct thread *td)
2400 {
2401         struct tdq *tdq;
2402
2403         KTR_STATE1(KTR_SCHED, "thread", sched_tdname(td), "runq rem",
2404             "prio:%d", td->td_priority);
2405         SDT_PROBE3(sched, , , dequeue, td, td->td_proc, NULL);
2406         tdq = TDQ_CPU(td->td_sched->ts_cpu);
2407         TDQ_LOCK_ASSERT(tdq, MA_OWNED);
2408         MPASS(td->td_lock == TDQ_LOCKPTR(tdq));
2409         KASSERT(TD_ON_RUNQ(td),
2410             ("sched_rem: thread not on run queue"));
2411         tdq_runq_rem(tdq, td);
2412         tdq_load_rem(tdq, td);
2413         TD_SET_CAN_RUN(td);
2414         if (td->td_priority == tdq->tdq_lowpri)
2415                 tdq_setlowpri(tdq, NULL);
2416 }
2417
2418 /*
2419  * Fetch cpu utilization information.  Updates on demand.
2420  */
2421 fixpt_t
2422 sched_pctcpu(struct thread *td)
2423 {
2424         fixpt_t pctcpu;
2425         struct td_sched *ts;
2426
2427         pctcpu = 0;
2428         ts = td->td_sched;
2429         if (ts == NULL)
2430                 return (0);
2431
2432         THREAD_LOCK_ASSERT(td, MA_OWNED);
2433         sched_pctcpu_update(ts, TD_IS_RUNNING(td));
2434         if (ts->ts_ticks) {
2435                 int rtick;
2436
2437                 /* How many rtick per second ? */
2438                 rtick = min(SCHED_TICK_HZ(ts) / SCHED_TICK_SECS, hz);
2439                 pctcpu = (FSCALE * ((FSCALE * rtick)/hz)) >> FSHIFT;
2440         }
2441
2442         return (pctcpu);
2443 }
2444
2445 /*
2446  * Enforce affinity settings for a thread.  Called after adjustments to
2447  * cpumask.
2448  */
2449 void
2450 sched_affinity(struct thread *td)
2451 {
2452 #ifdef SMP
2453         struct td_sched *ts;
2454
2455         THREAD_LOCK_ASSERT(td, MA_OWNED);
2456         ts = td->td_sched;
2457         if (THREAD_CAN_SCHED(td, ts->ts_cpu))
2458                 return;
2459         if (TD_ON_RUNQ(td)) {
2460                 sched_rem(td);
2461                 sched_add(td, SRQ_BORING);
2462                 return;
2463         }
2464         if (!TD_IS_RUNNING(td))
2465                 return;
2466         /*
2467          * Force a switch before returning to userspace.  If the
2468          * target thread is not running locally send an ipi to force
2469          * the issue.
2470          */
2471         td->td_flags |= TDF_NEEDRESCHED;
2472         if (td != curthread)
2473                 ipi_cpu(ts->ts_cpu, IPI_PREEMPT);
2474 #endif
2475 }
2476
2477 /*
2478  * Bind a thread to a target cpu.
2479  */
2480 void
2481 sched_bind(struct thread *td, int cpu)
2482 {
2483         struct td_sched *ts;
2484
2485         THREAD_LOCK_ASSERT(td, MA_OWNED|MA_NOTRECURSED);
2486         KASSERT(td == curthread, ("sched_bind: can only bind curthread"));
2487         ts = td->td_sched;
2488         if (ts->ts_flags & TSF_BOUND)
2489                 sched_unbind(td);
2490         KASSERT(THREAD_CAN_MIGRATE(td), ("%p must be migratable", td));
2491         ts->ts_flags |= TSF_BOUND;
2492         sched_pin();
2493         if (PCPU_GET(cpuid) == cpu)
2494                 return;
2495         ts->ts_cpu = cpu;
2496         /* When we return from mi_switch we'll be on the correct cpu. */
2497         mi_switch(SW_VOL, NULL);
2498 }
2499
2500 /*
2501  * Release a bound thread.
2502  */
2503 void
2504 sched_unbind(struct thread *td)
2505 {
2506         struct td_sched *ts;
2507
2508         THREAD_LOCK_ASSERT(td, MA_OWNED);
2509         KASSERT(td == curthread, ("sched_unbind: can only bind curthread"));
2510         ts = td->td_sched;
2511         if ((ts->ts_flags & TSF_BOUND) == 0)
2512                 return;
2513         ts->ts_flags &= ~TSF_BOUND;
2514         sched_unpin();
2515 }
2516
2517 int
2518 sched_is_bound(struct thread *td)
2519 {
2520         THREAD_LOCK_ASSERT(td, MA_OWNED);
2521         return (td->td_sched->ts_flags & TSF_BOUND);
2522 }
2523
2524 /*
2525  * Basic yield call.
2526  */
2527 void
2528 sched_relinquish(struct thread *td)
2529 {
2530         thread_lock(td);
2531         mi_switch(SW_VOL | SWT_RELINQUISH, NULL);
2532         thread_unlock(td);
2533 }
2534
2535 /*
2536  * Return the total system load.
2537  */
2538 int
2539 sched_load(void)
2540 {
2541 #ifdef SMP
2542         int total;
2543         int i;
2544
2545         total = 0;
2546         CPU_FOREACH(i)
2547                 total += TDQ_CPU(i)->tdq_sysload;
2548         return (total);
2549 #else
2550         return (TDQ_SELF()->tdq_sysload);
2551 #endif
2552 }
2553
2554 int
2555 sched_sizeof_proc(void)
2556 {
2557         return (sizeof(struct proc));
2558 }
2559
2560 int
2561 sched_sizeof_thread(void)
2562 {
2563         return (sizeof(struct thread) + sizeof(struct td_sched));
2564 }
2565
2566 #ifdef SMP
2567 #define TDQ_IDLESPIN(tdq)                                               \
2568     ((tdq)->tdq_cg != NULL && ((tdq)->tdq_cg->cg_flags & CG_FLAG_THREAD) == 0)
2569 #else
2570 #define TDQ_IDLESPIN(tdq)       1
2571 #endif
2572
2573 /*
2574  * The actual idle process.
2575  */
2576 void
2577 sched_idletd(void *dummy)
2578 {
2579         struct thread *td;
2580         struct tdq *tdq;
2581         int switchcnt;
2582         int i;
2583
2584         mtx_assert(&Giant, MA_NOTOWNED);
2585         td = curthread;
2586         tdq = TDQ_SELF();
2587         for (;;) {
2588 #ifdef SMP
2589                 if (tdq_idled(tdq) == 0)
2590                         continue;
2591 #endif
2592                 switchcnt = tdq->tdq_switchcnt + tdq->tdq_oldswitchcnt;
2593                 /*
2594                  * If we're switching very frequently, spin while checking
2595                  * for load rather than entering a low power state that
2596                  * may require an IPI.  However, don't do any busy
2597                  * loops while on SMT machines as this simply steals
2598                  * cycles from cores doing useful work.
2599                  */
2600                 if (TDQ_IDLESPIN(tdq) && switchcnt > sched_idlespinthresh) {
2601                         for (i = 0; i < sched_idlespins; i++) {
2602                                 if (tdq->tdq_load)
2603                                         break;
2604                                 cpu_spinwait();
2605                         }
2606                 }
2607                 switchcnt = tdq->tdq_switchcnt + tdq->tdq_oldswitchcnt;
2608                 if (tdq->tdq_load == 0) {
2609                         tdq->tdq_cpu_idle = 1;
2610                         if (tdq->tdq_load == 0) {
2611                                 cpu_idle(switchcnt > sched_idlespinthresh * 4);
2612                                 tdq->tdq_switchcnt++;
2613                         }
2614                         tdq->tdq_cpu_idle = 0;
2615                 }
2616                 if (tdq->tdq_load) {
2617                         thread_lock(td);
2618                         mi_switch(SW_VOL | SWT_IDLE, NULL);
2619                         thread_unlock(td);
2620                 }
2621         }
2622 }
2623
2624 /*
2625  * A CPU is entering for the first time or a thread is exiting.
2626  */
2627 void
2628 sched_throw(struct thread *td)
2629 {
2630         struct thread *newtd;
2631         struct tdq *tdq;
2632
2633         tdq = TDQ_SELF();
2634         if (td == NULL) {
2635                 /* Correct spinlock nesting and acquire the correct lock. */
2636                 TDQ_LOCK(tdq);
2637                 spinlock_exit();
2638                 PCPU_SET(switchtime, cpu_ticks());
2639                 PCPU_SET(switchticks, ticks);
2640         } else {
2641                 MPASS(td->td_lock == TDQ_LOCKPTR(tdq));
2642                 tdq_load_rem(tdq, td);
2643                 lock_profile_release_lock(&TDQ_LOCKPTR(tdq)->lock_object);
2644         }
2645         KASSERT(curthread->td_md.md_spinlock_count == 1, ("invalid count"));
2646         newtd = choosethread();
2647         TDQ_LOCKPTR(tdq)->mtx_lock = (uintptr_t)newtd;
2648         cpu_throw(td, newtd);           /* doesn't return */
2649 }
2650
2651 /*
2652  * This is called from fork_exit().  Just acquire the correct locks and
2653  * let fork do the rest of the work.
2654  */
2655 void
2656 sched_fork_exit(struct thread *td)
2657 {
2658         struct td_sched *ts;
2659         struct tdq *tdq;
2660         int cpuid;
2661
2662         /*
2663          * Finish setting up thread glue so that it begins execution in a
2664          * non-nested critical section with the scheduler lock held.
2665          */
2666         cpuid = PCPU_GET(cpuid);
2667         tdq = TDQ_CPU(cpuid);
2668         ts = td->td_sched;
2669         if (TD_IS_IDLETHREAD(td))
2670                 td->td_lock = TDQ_LOCKPTR(tdq);
2671         MPASS(td->td_lock == TDQ_LOCKPTR(tdq));
2672         td->td_oncpu = cpuid;
2673         TDQ_LOCK_ASSERT(tdq, MA_OWNED | MA_NOTRECURSED);
2674         lock_profile_obtain_lock_success(
2675             &TDQ_LOCKPTR(tdq)->lock_object, 0, 0, __FILE__, __LINE__);
2676 }
2677
2678 /*
2679  * Create on first use to catch odd startup conditons.
2680  */
2681 char *
2682 sched_tdname(struct thread *td)
2683 {
2684 #ifdef KTR
2685         struct td_sched *ts;
2686
2687         ts = td->td_sched;
2688         if (ts->ts_name[0] == '\0')
2689                 snprintf(ts->ts_name, sizeof(ts->ts_name),
2690                     "%s tid %d", td->td_name, td->td_tid);
2691         return (ts->ts_name);
2692 #else
2693         return (td->td_name);
2694 #endif
2695 }
2696
2697 #ifdef KTR
2698 void
2699 sched_clear_tdname(struct thread *td)
2700 {
2701         struct td_sched *ts;
2702
2703         ts = td->td_sched;
2704         ts->ts_name[0] = '\0';
2705 }
2706 #endif
2707
2708 #ifdef SMP
2709
2710 /*
2711  * Build the CPU topology dump string. Is recursively called to collect
2712  * the topology tree.
2713  */
2714 static int
2715 sysctl_kern_sched_topology_spec_internal(struct sbuf *sb, struct cpu_group *cg,
2716     int indent)
2717 {
2718         char cpusetbuf[CPUSETBUFSIZ];
2719         int i, first;
2720
2721         sbuf_printf(sb, "%*s<group level=\"%d\" cache-level=\"%d\">\n", indent,
2722             "", 1 + indent / 2, cg->cg_level);
2723         sbuf_printf(sb, "%*s <cpu count=\"%d\" mask=\"%s\">", indent, "",
2724             cg->cg_count, cpusetobj_strprint(cpusetbuf, &cg->cg_mask));
2725         first = TRUE;
2726         for (i = 0; i < MAXCPU; i++) {
2727                 if (CPU_ISSET(i, &cg->cg_mask)) {
2728                         if (!first)
2729                                 sbuf_printf(sb, ", ");
2730                         else
2731                                 first = FALSE;
2732                         sbuf_printf(sb, "%d", i);
2733                 }
2734         }
2735         sbuf_printf(sb, "</cpu>\n");
2736
2737         if (cg->cg_flags != 0) {
2738                 sbuf_printf(sb, "%*s <flags>", indent, "");
2739                 if ((cg->cg_flags & CG_FLAG_HTT) != 0)
2740                         sbuf_printf(sb, "<flag name=\"HTT\">HTT group</flag>");
2741                 if ((cg->cg_flags & CG_FLAG_THREAD) != 0)
2742                         sbuf_printf(sb, "<flag name=\"THREAD\">THREAD group</flag>");
2743                 if ((cg->cg_flags & CG_FLAG_SMT) != 0)
2744                         sbuf_printf(sb, "<flag name=\"SMT\">SMT group</flag>");
2745                 sbuf_printf(sb, "</flags>\n");
2746         }
2747
2748         if (cg->cg_children > 0) {
2749                 sbuf_printf(sb, "%*s <children>\n", indent, "");
2750                 for (i = 0; i < cg->cg_children; i++)
2751                         sysctl_kern_sched_topology_spec_internal(sb,
2752                             &cg->cg_child[i], indent+2);
2753                 sbuf_printf(sb, "%*s </children>\n", indent, "");
2754         }
2755         sbuf_printf(sb, "%*s</group>\n", indent, "");
2756         return (0);
2757 }
2758
2759 /*
2760  * Sysctl handler for retrieving topology dump. It's a wrapper for
2761  * the recursive sysctl_kern_smp_topology_spec_internal().
2762  */
2763 static int
2764 sysctl_kern_sched_topology_spec(SYSCTL_HANDLER_ARGS)
2765 {
2766         struct sbuf *topo;
2767         int err;
2768
2769         KASSERT(cpu_top != NULL, ("cpu_top isn't initialized"));
2770
2771         topo = sbuf_new(NULL, NULL, 500, SBUF_AUTOEXTEND);
2772         if (topo == NULL)
2773                 return (ENOMEM);
2774
2775         sbuf_printf(topo, "<groups>\n");
2776         err = sysctl_kern_sched_topology_spec_internal(topo, cpu_top, 1);
2777         sbuf_printf(topo, "</groups>\n");
2778
2779         if (err == 0) {
2780                 sbuf_finish(topo);
2781                 err = SYSCTL_OUT(req, sbuf_data(topo), sbuf_len(topo));
2782         }
2783         sbuf_delete(topo);
2784         return (err);
2785 }
2786
2787 #endif
2788
2789 SYSCTL_NODE(_kern, OID_AUTO, sched, CTLFLAG_RW, 0, "Scheduler");
2790 SYSCTL_STRING(_kern_sched, OID_AUTO, name, CTLFLAG_RD, "ULE", 0,
2791     "Scheduler name");
2792 SYSCTL_INT(_kern_sched, OID_AUTO, slice, CTLFLAG_RW, &sched_slice, 0,
2793     "Slice size for timeshare threads");
2794 SYSCTL_INT(_kern_sched, OID_AUTO, interact, CTLFLAG_RW, &sched_interact, 0,
2795      "Interactivity score threshold");
2796 SYSCTL_INT(_kern_sched, OID_AUTO, preempt_thresh, CTLFLAG_RW, &preempt_thresh,
2797      0,"Min priority for preemption, lower priorities have greater precedence");
2798 SYSCTL_INT(_kern_sched, OID_AUTO, static_boost, CTLFLAG_RW, &static_boost,
2799      0,"Controls whether static kernel priorities are assigned to sleeping threads.");
2800 SYSCTL_INT(_kern_sched, OID_AUTO, idlespins, CTLFLAG_RW, &sched_idlespins,
2801      0,"Number of times idle will spin waiting for new work.");
2802 SYSCTL_INT(_kern_sched, OID_AUTO, idlespinthresh, CTLFLAG_RW, &sched_idlespinthresh,
2803      0,"Threshold before we will permit idle spinning.");
2804 #ifdef SMP
2805 SYSCTL_INT(_kern_sched, OID_AUTO, affinity, CTLFLAG_RW, &affinity, 0,
2806     "Number of hz ticks to keep thread affinity for");
2807 SYSCTL_INT(_kern_sched, OID_AUTO, balance, CTLFLAG_RW, &rebalance, 0,
2808     "Enables the long-term load balancer");
2809 SYSCTL_INT(_kern_sched, OID_AUTO, balance_interval, CTLFLAG_RW,
2810     &balance_interval, 0,
2811     "Average frequency in stathz ticks to run the long-term balancer");
2812 SYSCTL_INT(_kern_sched, OID_AUTO, steal_idle, CTLFLAG_RW, &steal_idle, 0,
2813     "Attempts to steal work from other cores before idling");
2814 SYSCTL_INT(_kern_sched, OID_AUTO, steal_thresh, CTLFLAG_RW, &steal_thresh, 0,
2815     "Minimum load on remote cpu before we'll steal");
2816
2817 /* Retrieve SMP topology */
2818 SYSCTL_PROC(_kern_sched, OID_AUTO, topology_spec, CTLTYPE_STRING |
2819     CTLFLAG_RD, NULL, 0, sysctl_kern_sched_topology_spec, "A",
2820     "XML dump of detected CPU topology");
2821
2822 #endif
2823
2824 /* ps compat.  All cpu percentages from ULE are weighted. */
2825 static int ccpu = 0;
2826 SYSCTL_INT(_kern, OID_AUTO, ccpu, CTLFLAG_RD, &ccpu, 0, "");