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