2 * Copyright (c) 1982, 1986, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)kern_clock.c 8.5 (Berkeley) 1/21/94
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
41 #include "opt_device_polling.h"
42 #include "opt_hwpmc_hooks.h"
43 #include "opt_kdtrace.h"
45 #include "opt_watchdog.h"
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/callout.h>
51 #include <sys/kernel.h>
52 #include <sys/kthread.h>
55 #include <sys/mutex.h>
57 #include <sys/resource.h>
58 #include <sys/resourcevar.h>
59 #include <sys/sched.h>
61 #include <sys/signalvar.h>
62 #include <sys/sleepqueue.h>
66 #include <vm/vm_map.h>
67 #include <sys/sysctl.h>
69 #include <sys/interrupt.h>
70 #include <sys/limits.h>
71 #include <sys/timetc.h>
78 #include <sys/pmckern.h>
79 PMC_SOFT_DEFINE( , , clock, hard);
80 PMC_SOFT_DEFINE( , , clock, stat);
84 extern void hardclock_device_poll(void);
85 #endif /* DEVICE_POLLING */
87 static void initclocks(void *dummy);
88 SYSINIT(clocks, SI_SUB_CLOCKS, SI_ORDER_FIRST, initclocks, NULL);
90 /* Spin-lock protecting profiling statistics. */
91 static struct mtx time_lock;
93 SDT_PROVIDER_DECLARE(sched);
94 SDT_PROBE_DEFINE2(sched, , , tick, tick, "struct thread *", "struct proc *");
97 sysctl_kern_cp_time(SYSCTL_HANDLER_ARGS)
100 long cp_time[CPUSTATES];
103 unsigned int cp_time32[CPUSTATES];
106 read_cpu_time(cp_time);
108 if (req->flags & SCTL_MASK32) {
110 return SYSCTL_OUT(req, 0, sizeof(cp_time32));
111 for (i = 0; i < CPUSTATES; i++)
112 cp_time32[i] = (unsigned int)cp_time[i];
113 error = SYSCTL_OUT(req, cp_time32, sizeof(cp_time32));
118 return SYSCTL_OUT(req, 0, sizeof(cp_time));
119 error = SYSCTL_OUT(req, cp_time, sizeof(cp_time));
124 SYSCTL_PROC(_kern, OID_AUTO, cp_time, CTLTYPE_LONG|CTLFLAG_RD|CTLFLAG_MPSAFE,
125 0,0, sysctl_kern_cp_time, "LU", "CPU time statistics");
127 static long empty[CPUSTATES];
130 sysctl_kern_cp_times(SYSCTL_HANDLER_ARGS)
137 unsigned int cp_time32[CPUSTATES];
143 if (req->flags & SCTL_MASK32)
144 return SYSCTL_OUT(req, 0, sizeof(cp_time32) * (mp_maxid + 1));
147 return SYSCTL_OUT(req, 0, sizeof(long) * CPUSTATES * (mp_maxid + 1));
149 for (error = 0, c = 0; error == 0 && c <= mp_maxid; c++) {
150 if (!CPU_ABSENT(c)) {
152 cp_time = pcpu->pc_cp_time;
157 if (req->flags & SCTL_MASK32) {
158 for (i = 0; i < CPUSTATES; i++)
159 cp_time32[i] = (unsigned int)cp_time[i];
160 error = SYSCTL_OUT(req, cp_time32, sizeof(cp_time32));
163 error = SYSCTL_OUT(req, cp_time, sizeof(long) * CPUSTATES);
168 SYSCTL_PROC(_kern, OID_AUTO, cp_times, CTLTYPE_LONG|CTLFLAG_RD|CTLFLAG_MPSAFE,
169 0,0, sysctl_kern_cp_times, "LU", "per-CPU time statistics");
172 static const char *blessed[] = {
178 static int slptime_threshold = 1800;
179 static int blktime_threshold = 900;
180 static int sleepfreq = 3;
188 int blkticks, i, slpticks, slptype, tryl, tticks;
192 blkticks = blktime_threshold * hz;
193 slpticks = slptime_threshold * hz;
196 * Avoid to sleep on the sx_lock in order to avoid a possible
197 * priority inversion problem leading to starvation.
198 * If the lock can't be held after 100 tries, panic.
200 if (!sx_try_slock(&allproc_lock)) {
202 panic("%s: possible deadlock detected on allproc_lock\n",
205 pause("allproc", sleepfreq * hz);
209 FOREACH_PROC_IN_SYSTEM(p) {
211 if (p->p_state == PRS_NEW) {
215 FOREACH_THREAD_IN_PROC(p, td) {
218 * Once a thread is found in "interesting"
219 * state a possible ticks wrap-up needs to be
223 if (TD_ON_LOCK(td) && ticks < td->td_blktick) {
226 * The thread should be blocked on a
227 * turnstile, simply check if the
228 * turnstile channel is in good state.
230 MPASS(td->td_blocked != NULL);
232 tticks = ticks - td->td_blktick;
234 if (tticks > blkticks) {
237 * Accordingly with provided
238 * thresholds, this thread is
239 * stuck for too long on a
243 sx_sunlock(&allproc_lock);
244 panic("%s: possible deadlock detected for %p, blocked for %d ticks\n",
245 __func__, td, tticks);
247 } else if (TD_IS_SLEEPING(td) &&
249 ticks < td->td_blktick) {
252 * Check if the thread is sleeping on a
253 * lock, otherwise skip the check.
254 * Drop the thread lock in order to
255 * avoid a LOR with the sleepqueue
258 wchan = td->td_wchan;
259 tticks = ticks - td->td_slptick;
261 slptype = sleepq_type(wchan);
262 if ((slptype == SLEEPQ_SX ||
263 slptype == SLEEPQ_LK) &&
267 * Accordingly with provided
268 * thresholds, this thread is
269 * stuck for too long on a
271 * However, being on a
272 * sleepqueue, we might still
273 * check for the blessed
277 for (i = 0; blessed[i] != NULL;
279 if (!strcmp(blessed[i],
290 sx_sunlock(&allproc_lock);
291 panic("%s: possible deadlock detected for %p, blocked for %d ticks\n",
292 __func__, td, tticks);
299 sx_sunlock(&allproc_lock);
301 /* Sleep for sleepfreq seconds. */
302 pause("-", sleepfreq * hz);
306 static struct kthread_desc deadlkres_kd = {
309 (struct thread **)NULL
312 SYSINIT(deadlkres, SI_SUB_CLOCKS, SI_ORDER_ANY, kthread_start, &deadlkres_kd);
314 static SYSCTL_NODE(_debug, OID_AUTO, deadlkres, CTLFLAG_RW, 0,
315 "Deadlock resolver");
316 SYSCTL_INT(_debug_deadlkres, OID_AUTO, slptime_threshold, CTLFLAG_RW,
317 &slptime_threshold, 0,
318 "Number of seconds within is valid to sleep on a sleepqueue");
319 SYSCTL_INT(_debug_deadlkres, OID_AUTO, blktime_threshold, CTLFLAG_RW,
320 &blktime_threshold, 0,
321 "Number of seconds within is valid to block on a turnstile");
322 SYSCTL_INT(_debug_deadlkres, OID_AUTO, sleepfreq, CTLFLAG_RW, &sleepfreq, 0,
323 "Number of seconds between any deadlock resolver thread run");
324 #endif /* DEADLKRES */
327 read_cpu_time(long *cp_time)
332 /* Sum up global cp_time[]. */
333 bzero(cp_time, sizeof(long) * CPUSTATES);
336 for (j = 0; j < CPUSTATES; j++)
337 cp_time[j] += pc->pc_cp_time[j];
342 #include <sys/watchdog.h>
344 static int watchdog_ticks;
345 static int watchdog_enabled;
346 static void watchdog_fire(void);
347 static void watchdog_config(void *, u_int, int *);
348 #endif /* SW_WATCHDOG */
351 * Clock handling routines.
353 * This code is written to operate with two timers that run independently of
356 * The main timer, running hz times per second, is used to trigger interval
357 * timers, timeouts and rescheduling as needed.
359 * The second timer handles kernel and user profiling,
360 * and does resource use estimation. If the second timer is programmable,
361 * it is randomized to avoid aliasing between the two clocks. For example,
362 * the randomization prevents an adversary from always giving up the cpu
363 * just before its quantum expires. Otherwise, it would never accumulate
364 * cpu ticks. The mean frequency of the second timer is stathz.
366 * If no second timer exists, stathz will be zero; in this case we drive
367 * profiling and statistics off the main clock. This WILL NOT be accurate;
368 * do not do it unless absolutely necessary.
370 * The statistics clock may (or may not) be run at a higher rate while
371 * profiling. This profile clock runs at profhz. We require that profhz
372 * be an integral multiple of stathz.
374 * If the statistics clock is running fast, it must be divided by the ratio
375 * profhz/stathz for statistics. (For profiling, every tick counts.)
377 * Time-of-day is maintained using a "timecounter", which may or may
378 * not be related to the hardware generating the above mentioned
388 static DPCPU_DEFINE(int, pcputicks); /* Per-CPU version of ticks. */
389 static int global_hardclock_run = 0;
392 * Initialize clock frequencies and start both clocks running.
402 * Set divisors to 1 (normal case) and let the machine-specific
405 mtx_init(&time_lock, "time lock", NULL, MTX_DEF);
409 * Compute profhz/stathz, and fix profhz if needed.
411 i = stathz ? stathz : hz;
414 psratio = profhz / i;
416 EVENTHANDLER_REGISTER(watchdog_list, watchdog_config, NULL, 0);
421 * Each time the real-time timer fires, this function is called on all CPUs.
422 * Note that hardclock() calls hardclock_cpu() for the boot CPU, so only
423 * the other CPUs in the system need to call this function.
426 hardclock_cpu(int usermode)
428 struct pstats *pstats;
429 struct thread *td = curthread;
430 struct proc *p = td->td_proc;
434 * Run current process's virtual and profile time, as needed.
439 timevalisset(&pstats->p_timer[ITIMER_VIRTUAL].it_value)) {
441 if (itimerdecr(&pstats->p_timer[ITIMER_VIRTUAL], tick) == 0)
442 flags |= TDF_ALRMPEND | TDF_ASTPENDING;
445 if (timevalisset(&pstats->p_timer[ITIMER_PROF].it_value)) {
447 if (itimerdecr(&pstats->p_timer[ITIMER_PROF], tick) == 0)
448 flags |= TDF_PROFPEND | TDF_ASTPENDING;
453 td->td_flags |= flags;
457 if (PMC_CPU_HAS_SAMPLES(PCPU_GET(cpuid)))
458 PMC_CALL_HOOK_UNLOCKED(curthread, PMC_FN_DO_SAMPLES, NULL);
459 if (td->td_intr_frame != NULL)
460 PMC_SOFT_CALL_TF( , , clock, hard, td->td_intr_frame);
466 * The real-time timer, interrupting hz times per second.
469 hardclock(int usermode, uintfptr_t pc)
472 atomic_add_int((volatile int *)&ticks, 1);
473 hardclock_cpu(usermode);
475 cpu_tick_calibration();
477 * If no separate statistics clock is available, run it from here.
479 * XXX: this only works for UP
482 profclock(usermode, pc);
485 #ifdef DEVICE_POLLING
486 hardclock_device_poll(); /* this is very short and quick */
487 #endif /* DEVICE_POLLING */
489 if (watchdog_enabled > 0 && --watchdog_ticks <= 0)
491 #endif /* SW_WATCHDOG */
495 hardclock_cnt(int cnt, int usermode)
497 struct pstats *pstats;
498 struct thread *td = curthread;
499 struct proc *p = td->td_proc;
500 int *t = DPCPU_PTR(pcputicks);
501 int flags, global, newticks;
504 #endif /* SW_WATCHDOG */
507 * Update per-CPU and possibly global ticks values.
512 newticks = *t - global;
519 } while (!atomic_cmpset_int(&ticks, global, *t));
522 * Run current process's virtual and profile time, as needed.
527 timevalisset(&pstats->p_timer[ITIMER_VIRTUAL].it_value)) {
529 if (itimerdecr(&pstats->p_timer[ITIMER_VIRTUAL],
531 flags |= TDF_ALRMPEND | TDF_ASTPENDING;
534 if (timevalisset(&pstats->p_timer[ITIMER_PROF].it_value)) {
536 if (itimerdecr(&pstats->p_timer[ITIMER_PROF],
538 flags |= TDF_PROFPEND | TDF_ASTPENDING;
543 td->td_flags |= flags;
547 if (PMC_CPU_HAS_SAMPLES(PCPU_GET(cpuid)))
548 PMC_CALL_HOOK_UNLOCKED(curthread, PMC_FN_DO_SAMPLES, NULL);
549 if (td->td_intr_frame != NULL)
550 PMC_SOFT_CALL_TF( , , clock, hard, td->td_intr_frame);
553 /* We are in charge to handle this tick duty. */
555 /* Dangerous and no need to call these things concurrently. */
556 if (atomic_cmpset_acq_int(&global_hardclock_run, 0, 1)) {
557 tc_ticktock(newticks);
558 #ifdef DEVICE_POLLING
559 /* This is very short and quick. */
560 hardclock_device_poll();
561 #endif /* DEVICE_POLLING */
562 atomic_store_rel_int(&global_hardclock_run, 0);
565 if (watchdog_enabled > 0) {
566 i = atomic_fetchadd_int(&watchdog_ticks, -newticks);
567 if (i > 0 && i <= newticks)
570 #endif /* SW_WATCHDOG */
572 if (curcpu == CPU_FIRST())
573 cpu_tick_calibration();
577 hardclock_sync(int cpu)
579 int *t = DPCPU_ID_PTR(cpu, pcputicks);
585 * Compute number of ticks in the specified amount of time.
591 register unsigned long ticks;
592 register long sec, usec;
595 * If the number of usecs in the whole seconds part of the time
596 * difference fits in a long, then the total number of usecs will
597 * fit in an unsigned long. Compute the total and convert it to
598 * ticks, rounding up and adding 1 to allow for the current tick
599 * to expire. Rounding also depends on unsigned long arithmetic
602 * Otherwise, if the number of ticks in the whole seconds part of
603 * the time difference fits in a long, then convert the parts to
604 * ticks separately and add, using similar rounding methods and
605 * overflow avoidance. This method would work in the previous
606 * case but it is slightly slower and assumes that hz is integral.
608 * Otherwise, round the time difference down to the maximum
609 * representable value.
611 * If ints have 32 bits, then the maximum value for any timeout in
612 * 10ms ticks is 248 days.
626 printf("tvotohz: negative time difference %ld sec %ld usec\n",
630 } else if (sec <= LONG_MAX / 1000000)
631 ticks = (sec * 1000000 + (unsigned long)usec + (tick - 1))
633 else if (sec <= LONG_MAX / hz)
635 + ((unsigned long)usec + (tick - 1)) / tick + 1;
644 * Start profiling on a process.
646 * Kernel profiling passes proc0 which never exits and hence
647 * keeps the profile clock running constantly.
651 register struct proc *p;
654 PROC_LOCK_ASSERT(p, MA_OWNED);
655 if (p->p_flag & P_STOPPROF)
657 if ((p->p_flag & P_PROFIL) == 0) {
658 p->p_flag |= P_PROFIL;
659 mtx_lock(&time_lock);
660 if (++profprocs == 1)
661 cpu_startprofclock();
662 mtx_unlock(&time_lock);
667 * Stop profiling on a process.
671 register struct proc *p;
674 PROC_LOCK_ASSERT(p, MA_OWNED);
675 if (p->p_flag & P_PROFIL) {
676 if (p->p_profthreads != 0) {
677 p->p_flag |= P_STOPPROF;
678 while (p->p_profthreads != 0)
679 msleep(&p->p_profthreads, &p->p_mtx, PPAUSE,
681 p->p_flag &= ~P_STOPPROF;
683 if ((p->p_flag & P_PROFIL) == 0)
685 p->p_flag &= ~P_PROFIL;
686 mtx_lock(&time_lock);
687 if (--profprocs == 0)
689 mtx_unlock(&time_lock);
694 * Statistics clock. Updates rusage information and calls the scheduler
695 * to adjust priorities of the active thread.
697 * This should be called by all active processors.
700 statclock(int usermode)
703 statclock_cnt(1, usermode);
707 statclock_cnt(int cnt, int usermode)
719 cp_time = (long *)PCPU_PTR(cp_time);
722 * Charge the time as appropriate.
724 td->td_uticks += cnt;
725 if (p->p_nice > NZERO)
726 cp_time[CP_NICE] += cnt;
728 cp_time[CP_USER] += cnt;
731 * Came from kernel mode, so we were:
732 * - handling an interrupt,
733 * - doing syscall or trap work on behalf of the current
735 * - spinning in the idle loop.
736 * Whichever it is, charge the time as appropriate.
737 * Note that we charge interrupts to the current process,
738 * regardless of whether they are ``for'' that process,
739 * so that we know how much of its real time was spent
740 * in ``non-process'' (i.e., interrupt) work.
742 if ((td->td_pflags & TDP_ITHREAD) ||
743 td->td_intr_nesting_level >= 2) {
744 td->td_iticks += cnt;
745 cp_time[CP_INTR] += cnt;
747 td->td_pticks += cnt;
748 td->td_sticks += cnt;
749 if (!TD_IS_IDLETHREAD(td))
750 cp_time[CP_SYS] += cnt;
752 cp_time[CP_IDLE] += cnt;
756 /* Update resource usage integrals and maximums. */
757 MPASS(p->p_vmspace != NULL);
760 ru->ru_ixrss += pgtok(vm->vm_tsize) * cnt;
761 ru->ru_idrss += pgtok(vm->vm_dsize) * cnt;
762 ru->ru_isrss += pgtok(vm->vm_ssize) * cnt;
763 rss = pgtok(vmspace_resident_count(vm));
764 if (ru->ru_maxrss < rss)
766 KTR_POINT2(KTR_SCHED, "thread", sched_tdname(td), "statclock",
767 "prio:%d", td->td_priority, "stathz:%d", (stathz)?stathz:hz);
768 SDT_PROBE2(sched, , , tick, td, td->td_proc);
769 thread_lock_flags(td, MTX_QUIET);
770 for ( ; cnt > 0; cnt--)
774 if (td->td_intr_frame != NULL)
775 PMC_SOFT_CALL_TF( , , clock, stat, td->td_intr_frame);
780 profclock(int usermode, uintfptr_t pc)
783 profclock_cnt(1, usermode, pc);
787 profclock_cnt(int cnt, int usermode, uintfptr_t pc)
798 * Came from user mode; CPU was in user state.
799 * If this process is being profiled, record the tick.
800 * if there is no related user location yet, don't
801 * bother trying to count it.
803 if (td->td_proc->p_flag & P_PROFIL)
804 addupc_intr(td, pc, cnt);
809 * Kernel statistics are just like addupc_intr, only easier.
812 if (g->state == GMON_PROF_ON && pc >= g->lowpc) {
814 if (i < g->textsize) {
823 * Return information about system clocks.
826 sysctl_kern_clockrate(SYSCTL_HANDLER_ARGS)
828 struct clockinfo clkinfo;
830 * Construct clockinfo structure.
832 bzero(&clkinfo, sizeof(clkinfo));
835 clkinfo.profhz = profhz;
836 clkinfo.stathz = stathz ? stathz : hz;
837 return (sysctl_handle_opaque(oidp, &clkinfo, sizeof clkinfo, req));
840 SYSCTL_PROC(_kern, KERN_CLOCKRATE, clockrate,
841 CTLTYPE_STRUCT|CTLFLAG_RD|CTLFLAG_MPSAFE,
842 0, 0, sysctl_kern_clockrate, "S,clockinfo",
843 "Rate and period of various kernel clocks");
848 watchdog_config(void *unused __unused, u_int cmd, int *error)
852 u = cmd & WD_INTERVAL;
853 if (u >= WD_TO_1SEC) {
854 watchdog_ticks = (1 << (u - WD_TO_1SEC)) * hz;
855 watchdog_enabled = 1;
858 watchdog_enabled = 0;
863 * Handle a watchdog timeout by dumping interrupt information and
864 * then either dropping to DDB or panicking.
877 nintr = sintrcnt / sizeof(u_long);
879 printf("interrupt total\n");
880 while (--nintr >= 0) {
882 printf("%-12s %20lu\n", curname, *curintr);
883 curname += strlen(curname) + 1;
884 inttotal += *curintr++;
886 printf("Total %20ju\n", (uintmax_t)inttotal);
888 #if defined(KDB) && !defined(KDB_UNATTENDED)
890 kdb_enter(KDB_WHY_WATCHDOG, "watchdog timeout");
892 panic("watchdog timeout");
896 #endif /* SW_WATCHDOG */