Move the polling systimer initialization code out of kern_clock.c and into
[dragonfly.git] / sys / kern / kern_clock.c
1 /*
2  * Copyright (c) 2003,2004 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * Copyright (c) 1997, 1998 Poul-Henning Kamp <phk@FreeBSD.org>
35  * Copyright (c) 1982, 1986, 1991, 1993
36  *      The Regents of the University of California.  All rights reserved.
37  * (c) UNIX System Laboratories, Inc.
38  * All or some portions of this file are derived from material licensed
39  * to the University of California by American Telephone and Telegraph
40  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
41  * the permission of UNIX System Laboratories, Inc.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *      This product includes software developed by the University of
54  *      California, Berkeley and its contributors.
55  * 4. Neither the name of the University nor the names of its contributors
56  *    may be used to endorse or promote products derived from this software
57  *    without specific prior written permission.
58  *
59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69  * SUCH DAMAGE.
70  *
71  *      @(#)kern_clock.c        8.5 (Berkeley) 1/21/94
72  * $FreeBSD: src/sys/kern/kern_clock.c,v 1.105.2.10 2002/10/17 13:19:40 maxim Exp $
73  * $DragonFly: src/sys/kern/kern_clock.c,v 1.49 2005/10/13 00:45:36 dillon Exp $
74  */
75
76 #include "opt_ntp.h"
77
78 #include <sys/param.h>
79 #include <sys/systm.h>
80 #include <sys/callout.h>
81 #include <sys/kernel.h>
82 #include <sys/kinfo.h>
83 #include <sys/proc.h>
84 #include <sys/malloc.h>
85 #include <sys/resourcevar.h>
86 #include <sys/signalvar.h>
87 #include <sys/timex.h>
88 #include <sys/timepps.h>
89 #include <vm/vm.h>
90 #include <sys/lock.h>
91 #include <vm/pmap.h>
92 #include <vm/vm_map.h>
93 #include <sys/sysctl.h>
94 #include <sys/thread2.h>
95
96 #include <machine/cpu.h>
97 #include <machine/limits.h>
98 #include <machine/smp.h>
99
100 #ifdef GPROF
101 #include <sys/gmon.h>
102 #endif
103
104 #ifdef DEVICE_POLLING
105 extern void init_device_poll(void);
106 #endif
107
108 static void initclocks (void *dummy);
109 SYSINIT(clocks, SI_SUB_CLOCKS, SI_ORDER_FIRST, initclocks, NULL)
110
111 /*
112  * Some of these don't belong here, but it's easiest to concentrate them.
113  * Note that cpu_time counts in microseconds, but most userland programs
114  * just compare relative times against the total by delta.
115  */
116 struct kinfo_cputime cputime_percpu[MAXCPU];
117 #ifdef SMP
118 static int
119 sysctl_cputime(SYSCTL_HANDLER_ARGS)
120 {
121         int cpu, error = 0;
122         size_t size = sizeof(struct kinfo_cputime);
123
124         for (cpu = 0; cpu < ncpus; ++cpu) {
125                 if ((error = SYSCTL_OUT(req, &cputime_percpu[cpu], size)))
126                         break;
127         }
128
129         return (error);
130 }
131 SYSCTL_PROC(_kern, OID_AUTO, cputime, (CTLTYPE_OPAQUE|CTLFLAG_RD), 0, 0,
132         sysctl_cputime, "S,kinfo_cputime", "CPU time statistics");
133 #else
134 SYSCTL_STRUCT(_kern, OID_AUTO, cputime, CTLFLAG_RD, &cpu_time, kinfo_cputime,
135     "CPU time statistics");
136 #endif
137
138 /*
139  * boottime is used to calculate the 'real' uptime.  Do not confuse this with
140  * microuptime().  microtime() is not drift compensated.  The real uptime
141  * with compensation is nanotime() - bootime.  boottime is recalculated
142  * whenever the real time is set based on the compensated elapsed time
143  * in seconds (gd->gd_time_seconds).
144  *
145  * The gd_time_seconds and gd_cpuclock_base fields remain fairly monotonic.
146  * Slight adjustments to gd_cpuclock_base are made to phase-lock it to
147  * the real time.
148  */
149 struct timespec boottime;       /* boot time (realtime) for reference only */
150 time_t time_second;             /* read-only 'passive' uptime in seconds */
151
152 /*
153  * basetime is used to calculate the compensated real time of day.  The
154  * basetime can be modified on a per-tick basis by the adjtime(), 
155  * ntp_adjtime(), and sysctl-based time correction APIs.
156  *
157  * Note that frequency corrections can also be made by adjusting
158  * gd_cpuclock_base.
159  *
160  * basetime is a tail-chasing FIFO, updated only by cpu #0.  The FIFO is
161  * used on both SMP and UP systems to avoid MP races between cpu's and
162  * interrupt races on UP systems.
163  */
164 #define BASETIME_ARYSIZE        16
165 #define BASETIME_ARYMASK        (BASETIME_ARYSIZE - 1)
166 static struct timespec basetime[BASETIME_ARYSIZE];
167 static volatile int basetime_index;
168
169 static int
170 sysctl_get_basetime(SYSCTL_HANDLER_ARGS)
171 {
172         struct timespec *bt;
173         int error;
174         int index;
175
176         /*
177          * Because basetime data and index may be updated by another cpu,
178          * a load fence is required to ensure that the data we read has
179          * not been speculatively read relative to a possibly updated index.
180          */
181         index = basetime_index;
182         cpu_lfence();
183         bt = &basetime[index];
184         error = SYSCTL_OUT(req, bt, sizeof(*bt));
185         return (error);
186 }
187
188 SYSCTL_STRUCT(_kern, KERN_BOOTTIME, boottime, CTLFLAG_RD,
189     &boottime, timespec, "System boottime");
190 SYSCTL_PROC(_kern, OID_AUTO, basetime, CTLTYPE_STRUCT|CTLFLAG_RD, 0, 0,
191     sysctl_get_basetime, "S,timespec", "System basetime");
192
193 static void hardclock(systimer_t info, struct intrframe *frame);
194 static void statclock(systimer_t info, struct intrframe *frame);
195 static void schedclock(systimer_t info, struct intrframe *frame);
196 static void getnanotime_nbt(struct timespec *nbt, struct timespec *tsp);
197
198 int     ticks;                  /* system master ticks at hz */
199 int     clocks_running;         /* tsleep/timeout clocks operational */
200 int64_t nsec_adj;               /* ntpd per-tick adjustment in nsec << 32 */
201 int64_t nsec_acc;               /* accumulator */
202
203 /* NTPD time correction fields */
204 int64_t ntp_tick_permanent;     /* per-tick adjustment in nsec << 32 */
205 int64_t ntp_tick_acc;           /* accumulator for per-tick adjustment */
206 int64_t ntp_delta;              /* one-time correction in nsec */
207 int64_t ntp_big_delta = 1000000000;
208 int32_t ntp_tick_delta;         /* current adjustment rate */
209 int32_t ntp_default_tick_delta; /* adjustment rate for ntp_delta */
210 time_t  ntp_leap_second;        /* time of next leap second */
211 int     ntp_leap_insert;        /* whether to insert or remove a second */
212
213 /*
214  * Finish initializing clock frequencies and start all clocks running.
215  */
216 /* ARGSUSED*/
217 static void
218 initclocks(void *dummy)
219 {
220         cpu_initclocks();
221 #ifdef DEVICE_POLLING
222         init_device_poll();
223 #endif
224         /*psratio = profhz / stathz;*/
225         initclocks_pcpu();
226         clocks_running = 1;
227 }
228
229 /*
230  * Called on a per-cpu basis
231  */
232 void
233 initclocks_pcpu(void)
234 {
235         struct globaldata *gd = mycpu;
236
237         crit_enter();
238         if (gd->gd_cpuid == 0) {
239             gd->gd_time_seconds = 1;
240             gd->gd_cpuclock_base = sys_cputimer->count();
241         } else {
242             /* XXX */
243             gd->gd_time_seconds = globaldata_find(0)->gd_time_seconds;
244             gd->gd_cpuclock_base = globaldata_find(0)->gd_cpuclock_base;
245         }
246
247         /*
248          * Use a non-queued periodic systimer to prevent multiple ticks from
249          * building up if the sysclock jumps forward (8254 gets reset).  The
250          * sysclock will never jump backwards.  Our time sync is based on
251          * the actual sysclock, not the ticks count.
252          */
253         systimer_init_periodic_nq(&gd->gd_hardclock, hardclock, NULL, hz);
254         systimer_init_periodic_nq(&gd->gd_statclock, statclock, NULL, stathz);
255         /* XXX correct the frequency for scheduler / estcpu tests */
256         systimer_init_periodic_nq(&gd->gd_schedclock, schedclock, 
257                                 NULL, ESTCPUFREQ); 
258         crit_exit();
259 }
260
261 /*
262  * This sets the current real time of day.  Timespecs are in seconds and
263  * nanoseconds.  We do not mess with gd_time_seconds and gd_cpuclock_base,
264  * instead we adjust basetime so basetime + gd_* results in the current
265  * time of day.  This way the gd_* fields are guarenteed to represent
266  * a monotonically increasing 'uptime' value.
267  *
268  * When set_timeofday() is called from userland, the system call forces it
269  * onto cpu #0 since only cpu #0 can update basetime_index.
270  */
271 void
272 set_timeofday(struct timespec *ts)
273 {
274         struct timespec *nbt;
275         int ni;
276
277         /*
278          * XXX SMP / non-atomic basetime updates
279          */
280         crit_enter();
281         ni = (basetime_index + 1) & BASETIME_ARYMASK;
282         nbt = &basetime[ni];
283         nanouptime(nbt);
284         nbt->tv_sec = ts->tv_sec - nbt->tv_sec;
285         nbt->tv_nsec = ts->tv_nsec - nbt->tv_nsec;
286         if (nbt->tv_nsec < 0) {
287             nbt->tv_nsec += 1000000000;
288             --nbt->tv_sec;
289         }
290
291         /*
292          * Note that basetime diverges from boottime as the clock drift is
293          * compensated for, so we cannot do away with boottime.  When setting
294          * the absolute time of day the drift is 0 (for an instant) and we
295          * can simply assign boottime to basetime.  
296          *
297          * Note that nanouptime() is based on gd_time_seconds which is drift
298          * compensated up to a point (it is guarenteed to remain monotonically
299          * increasing).  gd_time_seconds is thus our best uptime guess and
300          * suitable for use in the boottime calculation.  It is already taken
301          * into account in the basetime calculation above.
302          */
303         boottime.tv_sec = nbt->tv_sec;
304         ntp_delta = 0;
305
306         /*
307          * We now have a new basetime, make sure all other cpus have it,
308          * then update the index.
309          */
310         cpu_sfence();
311         basetime_index = ni;
312
313         crit_exit();
314 }
315         
316 /*
317  * Each cpu has its own hardclock, but we only increments ticks and softticks
318  * on cpu #0.
319  *
320  * NOTE! systimer! the MP lock might not be held here.  We can only safely
321  * manipulate objects owned by the current cpu.
322  */
323 static void
324 hardclock(systimer_t info, struct intrframe *frame)
325 {
326         sysclock_t cputicks;
327         struct proc *p;
328         struct pstats *pstats;
329         struct globaldata *gd = mycpu;
330
331         /*
332          * Realtime updates are per-cpu.  Note that timer corrections as
333          * returned by microtime() and friends make an additional adjustment
334          * using a system-wise 'basetime', but the running time is always
335          * taken from the per-cpu globaldata area.  Since the same clock
336          * is distributing (XXX SMP) to all cpus, the per-cpu timebases
337          * stay in synch.
338          *
339          * Note that we never allow info->time (aka gd->gd_hardclock.time)
340          * to reverse index gd_cpuclock_base, but that it is possible for
341          * it to temporarily get behind in the seconds if something in the
342          * system locks interrupts for a long period of time.  Since periodic
343          * timers count events, though everything should resynch again
344          * immediately.
345          */
346         cputicks = info->time - gd->gd_cpuclock_base;
347         if (cputicks >= sys_cputimer->freq) {
348                 ++gd->gd_time_seconds;
349                 gd->gd_cpuclock_base += sys_cputimer->freq;
350         }
351
352         /*
353          * The system-wide ticks counter and NTP related timedelta/tickdelta
354          * adjustments only occur on cpu #0.  NTP adjustments are accomplished
355          * by updating basetime.
356          */
357         if (gd->gd_cpuid == 0) {
358             struct timespec *nbt;
359             struct timespec nts;
360             int leap;
361             int ni;
362
363             ++ticks;
364
365 #if 0
366             if (tco->tc_poll_pps) 
367                 tco->tc_poll_pps(tco);
368 #endif
369
370             /*
371              * Calculate the new basetime index.  We are in a critical section
372              * on cpu #0 and can safely play with basetime_index.  Start
373              * with the current basetime and then make adjustments.
374              */
375             ni = (basetime_index + 1) & BASETIME_ARYMASK;
376             nbt = &basetime[ni];
377             *nbt = basetime[basetime_index];
378
379             /*
380              * Apply adjtime corrections.  (adjtime() API)
381              *
382              * adjtime() only runs on cpu #0 so our critical section is
383              * sufficient to access these variables.
384              */
385             if (ntp_delta != 0) {
386                 nbt->tv_nsec += ntp_tick_delta;
387                 ntp_delta -= ntp_tick_delta;
388                 if ((ntp_delta > 0 && ntp_delta < ntp_tick_delta) ||
389                     (ntp_delta < 0 && ntp_delta > ntp_tick_delta)) {
390                         ntp_tick_delta = ntp_delta;
391                 }
392             }
393
394             /*
395              * Apply permanent frequency corrections.  (sysctl API)
396              */
397             if (ntp_tick_permanent != 0) {
398                 ntp_tick_acc += ntp_tick_permanent;
399                 if (ntp_tick_acc >= (1LL << 32)) {
400                     nbt->tv_nsec += ntp_tick_acc >> 32;
401                     ntp_tick_acc -= (ntp_tick_acc >> 32) << 32;
402                 } else if (ntp_tick_acc <= -(1LL << 32)) {
403                     /* Negate ntp_tick_acc to avoid shifting the sign bit. */
404                     nbt->tv_nsec -= (-ntp_tick_acc) >> 32;
405                     ntp_tick_acc += ((-ntp_tick_acc) >> 32) << 32;
406                 }
407             }
408
409             if (nbt->tv_nsec >= 1000000000) {
410                     nbt->tv_sec++;
411                     nbt->tv_nsec -= 1000000000;
412             } else if (nbt->tv_nsec < 0) {
413                     nbt->tv_sec--;
414                     nbt->tv_nsec += 1000000000;
415             }
416
417             /*
418              * Another per-tick compensation.  (for ntp_adjtime() API)
419              */
420             if (nsec_adj != 0) {
421                 nsec_acc += nsec_adj;
422                 if (nsec_acc >= 0x100000000LL) {
423                     nbt->tv_nsec += nsec_acc >> 32;
424                     nsec_acc = (nsec_acc & 0xFFFFFFFFLL);
425                 } else if (nsec_acc <= -0x100000000LL) {
426                     nbt->tv_nsec -= -nsec_acc >> 32;
427                     nsec_acc = -(-nsec_acc & 0xFFFFFFFFLL);
428                 }
429                 if (nbt->tv_nsec >= 1000000000) {
430                     nbt->tv_nsec -= 1000000000;
431                     ++nbt->tv_sec;
432                 } else if (nbt->tv_nsec < 0) {
433                     nbt->tv_nsec += 1000000000;
434                     --nbt->tv_sec;
435                 }
436             }
437
438             /************************************************************
439              *                  LEAP SECOND CORRECTION                  *
440              ************************************************************
441              *
442              * Taking into account all the corrections made above, figure
443              * out the new real time.  If the seconds field has changed
444              * then apply any pending leap-second corrections.
445              */
446             getnanotime_nbt(nbt, &nts);
447
448             if (time_second != nts.tv_sec) {
449                 /*
450                  * Apply leap second (sysctl API).  Adjust nts for changes
451                  * so we do not have to call getnanotime_nbt again.
452                  */
453                 if (ntp_leap_second) {
454                     if (ntp_leap_second == nts.tv_sec) {
455                         if (ntp_leap_insert) {
456                             nbt->tv_sec++;
457                             nts.tv_sec++;
458                         } else {
459                             nbt->tv_sec--;
460                             nts.tv_sec--;
461                         }
462                         ntp_leap_second--;
463                     }
464                 }
465
466                 /*
467                  * Apply leap second (ntp_adjtime() API), calculate a new
468                  * nsec_adj field.  ntp_update_second() returns nsec_adj
469                  * as a per-second value but we need it as a per-tick value.
470                  */
471                 leap = ntp_update_second(time_second, &nsec_adj);
472                 nsec_adj /= hz;
473                 nbt->tv_sec += leap;
474                 nts.tv_sec += leap;
475
476                 /*
477                  * Update the time_second 'approximate time' global.
478                  */
479                 time_second = nts.tv_sec;
480             }
481
482             /*
483              * Finally, our new basetime is ready to go live!
484              */
485             cpu_sfence();
486             basetime_index = ni;
487         }
488
489         /*
490          * softticks are handled for all cpus
491          */
492         hardclock_softtick(gd);
493
494         /*
495          * ITimer handling is per-tick, per-cpu.  I don't think psignal()
496          * is mpsafe on curproc, so XXX get the mplock.
497          */
498         if ((p = curproc) != NULL && try_mplock()) {
499                 pstats = p->p_stats;
500                 if (frame && CLKF_USERMODE(frame) &&
501                     timevalisset(&p->p_timer[ITIMER_VIRTUAL].it_value) &&
502                     itimerdecr(&p->p_timer[ITIMER_VIRTUAL], tick) == 0)
503                         psignal(p, SIGVTALRM);
504                 if (timevalisset(&p->p_timer[ITIMER_PROF].it_value) &&
505                     itimerdecr(&p->p_timer[ITIMER_PROF], tick) == 0)
506                         psignal(p, SIGPROF);
507                 rel_mplock();
508         }
509         setdelayed();
510 }
511
512 /*
513  * The statistics clock typically runs at a 125Hz rate, and is intended
514  * to be frequency offset from the hardclock (typ 100Hz).  It is per-cpu.
515  *
516  * NOTE! systimer! the MP lock might not be held here.  We can only safely
517  * manipulate objects owned by the current cpu.
518  *
519  * The stats clock is responsible for grabbing a profiling sample.
520  * Most of the statistics are only used by user-level statistics programs.
521  * The main exceptions are p->p_uticks, p->p_sticks, p->p_iticks, and
522  * p->p_estcpu.
523  *
524  * Like the other clocks, the stat clock is called from what is effectively
525  * a fast interrupt, so the context should be the thread/process that got
526  * interrupted.
527  */
528 static void
529 statclock(systimer_t info, struct intrframe *frame)
530 {
531 #ifdef GPROF
532         struct gmonparam *g;
533         int i;
534 #endif
535         thread_t td;
536         struct proc *p;
537         int bump;
538         struct timeval tv;
539         struct timeval *stv;
540
541         /*
542          * How big was our timeslice relative to the last time?
543          */
544         microuptime(&tv);       /* mpsafe */
545         stv = &mycpu->gd_stattv;
546         if (stv->tv_sec == 0) {
547             bump = 1;
548         } else {
549             bump = tv.tv_usec - stv->tv_usec +
550                 (tv.tv_sec - stv->tv_sec) * 1000000;
551             if (bump < 0)
552                 bump = 0;
553             if (bump > 1000000)
554                 bump = 1000000;
555         }
556         *stv = tv;
557
558         td = curthread;
559         p = td->td_proc;
560
561         if (frame && CLKF_USERMODE(frame)) {
562                 /*
563                  * Came from userland, handle user time and deal with
564                  * possible process.
565                  */
566                 if (p && (p->p_flag & P_PROFIL))
567                         addupc_intr(p, CLKF_PC(frame), 1);
568                 td->td_uticks += bump;
569
570                 /*
571                  * Charge the time as appropriate
572                  */
573                 if (p && p->p_nice > NZERO)
574                         cpu_time.cp_nice += bump;
575                 else
576                         cpu_time.cp_user += bump;
577         } else {
578 #ifdef GPROF
579                 /*
580                  * Kernel statistics are just like addupc_intr, only easier.
581                  */
582                 g = &_gmonparam;
583                 if (g->state == GMON_PROF_ON && frame) {
584                         i = CLKF_PC(frame) - g->lowpc;
585                         if (i < g->textsize) {
586                                 i /= HISTFRACTION * sizeof(*g->kcount);
587                                 g->kcount[i]++;
588                         }
589                 }
590 #endif
591                 /*
592                  * Came from kernel mode, so we were:
593                  * - handling an interrupt,
594                  * - doing syscall or trap work on behalf of the current
595                  *   user process, or
596                  * - spinning in the idle loop.
597                  * Whichever it is, charge the time as appropriate.
598                  * Note that we charge interrupts to the current process,
599                  * regardless of whether they are ``for'' that process,
600                  * so that we know how much of its real time was spent
601                  * in ``non-process'' (i.e., interrupt) work.
602                  *
603                  * XXX assume system if frame is NULL.  A NULL frame 
604                  * can occur if ipi processing is done from a crit_exit().
605                  */
606                 if (frame && CLKF_INTR(frame))
607                         td->td_iticks += bump;
608                 else
609                         td->td_sticks += bump;
610
611                 if (frame && CLKF_INTR(frame)) {
612                         cpu_time.cp_intr += bump;
613                 } else {
614                         if (td == &mycpu->gd_idlethread)
615                                 cpu_time.cp_idle += bump;
616                         else
617                                 cpu_time.cp_sys += bump;
618                 }
619         }
620 }
621
622 /*
623  * The scheduler clock typically runs at a 50Hz rate.  NOTE! systimer,
624  * the MP lock might not be held.  We can safely manipulate parts of curproc
625  * but that's about it.
626  *
627  * Each cpu has its own scheduler clock.
628  */
629 static void
630 schedclock(systimer_t info, struct intrframe *frame)
631 {
632         struct lwp *lp;
633         struct pstats *pstats;
634         struct rusage *ru;
635         struct vmspace *vm;
636         long rss;
637
638         if ((lp = lwkt_preempted_proc()) != NULL) {
639                 /*
640                  * Account for cpu time used and hit the scheduler.  Note
641                  * that this call MUST BE MP SAFE, and the BGL IS NOT HELD
642                  * HERE.
643                  */
644                 ++lp->lwp_cpticks;
645                 /*
646                  * XXX I think accessing lwp_proc's p_usched is
647                  * reasonably MP safe.  This needs to be revisited
648                  * when we have pluggable schedulers.
649                  */
650                 lp->lwp_proc->p_usched->schedulerclock(lp, info->periodic, info->time);
651         }
652         if ((lp = curthread->td_lwp) != NULL) {
653                 /*
654                  * Update resource usage integrals and maximums.
655                  */
656                 if ((pstats = lp->lwp_stats) != NULL &&
657                     (ru = &pstats->p_ru) != NULL &&
658                     (vm = lp->lwp_proc->p_vmspace) != NULL) {
659                         ru->ru_ixrss += pgtok(vm->vm_tsize);
660                         ru->ru_idrss += pgtok(vm->vm_dsize);
661                         ru->ru_isrss += pgtok(vm->vm_ssize);
662                         rss = pgtok(vmspace_resident_count(vm));
663                         if (ru->ru_maxrss < rss)
664                                 ru->ru_maxrss = rss;
665                 }
666         }
667 }
668
669 /*
670  * Compute number of ticks for the specified amount of time.  The 
671  * return value is intended to be used in a clock interrupt timed
672  * operation and guarenteed to meet or exceed the requested time.
673  * If the representation overflows, return INT_MAX.  The minimum return
674  * value is 1 ticks and the function will average the calculation up.
675  * If any value greater then 0 microseconds is supplied, a value
676  * of at least 2 will be returned to ensure that a near-term clock
677  * interrupt does not cause the timeout to occur (degenerately) early.
678  *
679  * Note that limit checks must take into account microseconds, which is
680  * done simply by using the smaller signed long maximum instead of
681  * the unsigned long maximum.
682  *
683  * If ints have 32 bits, then the maximum value for any timeout in
684  * 10ms ticks is 248 days.
685  */
686 int
687 tvtohz_high(struct timeval *tv)
688 {
689         int ticks;
690         long sec, usec;
691
692         sec = tv->tv_sec;
693         usec = tv->tv_usec;
694         if (usec < 0) {
695                 sec--;
696                 usec += 1000000;
697         }
698         if (sec < 0) {
699 #ifdef DIAGNOSTIC
700                 if (usec > 0) {
701                         sec++;
702                         usec -= 1000000;
703                 }
704                 printf("tvotohz: negative time difference %ld sec %ld usec\n",
705                        sec, usec);
706 #endif
707                 ticks = 1;
708         } else if (sec <= INT_MAX / hz) {
709                 ticks = (int)(sec * hz + 
710                             ((u_long)usec + (tick - 1)) / tick) + 1;
711         } else {
712                 ticks = INT_MAX;
713         }
714         return (ticks);
715 }
716
717 /*
718  * Compute number of ticks for the specified amount of time, erroring on
719  * the side of it being too low to ensure that sleeping the returned number
720  * of ticks will not result in a late return.
721  *
722  * The supplied timeval may not be negative and should be normalized.  A
723  * return value of 0 is possible if the timeval converts to less then
724  * 1 tick.
725  *
726  * If ints have 32 bits, then the maximum value for any timeout in
727  * 10ms ticks is 248 days.
728  */
729 int
730 tvtohz_low(struct timeval *tv)
731 {
732         int ticks;
733         long sec;
734
735         sec = tv->tv_sec;
736         if (sec <= INT_MAX / hz)
737                 ticks = (int)(sec * hz + (u_long)tv->tv_usec / tick);
738         else
739                 ticks = INT_MAX;
740         return (ticks);
741 }
742
743
744 /*
745  * Start profiling on a process.
746  *
747  * Kernel profiling passes proc0 which never exits and hence
748  * keeps the profile clock running constantly.
749  */
750 void
751 startprofclock(struct proc *p)
752 {
753         if ((p->p_flag & P_PROFIL) == 0) {
754                 p->p_flag |= P_PROFIL;
755 #if 0   /* XXX */
756                 if (++profprocs == 1 && stathz != 0) {
757                         crit_enter();
758                         psdiv = psratio;
759                         setstatclockrate(profhz);
760                         crit_exit();
761                 }
762 #endif
763         }
764 }
765
766 /*
767  * Stop profiling on a process.
768  */
769 void
770 stopprofclock(struct proc *p)
771 {
772         if (p->p_flag & P_PROFIL) {
773                 p->p_flag &= ~P_PROFIL;
774 #if 0   /* XXX */
775                 if (--profprocs == 0 && stathz != 0) {
776                         crit_enter();
777                         psdiv = 1;
778                         setstatclockrate(stathz);
779                         crit_exit();
780                 }
781 #endif
782         }
783 }
784
785 /*
786  * Return information about system clocks.
787  */
788 static int
789 sysctl_kern_clockrate(SYSCTL_HANDLER_ARGS)
790 {
791         struct kinfo_clockinfo clkinfo;
792         /*
793          * Construct clockinfo structure.
794          */
795         clkinfo.ci_hz = hz;
796         clkinfo.ci_tick = tick;
797         clkinfo.ci_tickadj = ntp_default_tick_delta / 1000;
798         clkinfo.ci_profhz = profhz;
799         clkinfo.ci_stathz = stathz ? stathz : hz;
800         return (sysctl_handle_opaque(oidp, &clkinfo, sizeof clkinfo, req));
801 }
802
803 SYSCTL_PROC(_kern, KERN_CLOCKRATE, clockrate, CTLTYPE_STRUCT|CTLFLAG_RD,
804         0, 0, sysctl_kern_clockrate, "S,clockinfo","");
805
806 /*
807  * We have eight functions for looking at the clock, four for
808  * microseconds and four for nanoseconds.  For each there is fast
809  * but less precise version "get{nano|micro}[up]time" which will
810  * return a time which is up to 1/HZ previous to the call, whereas
811  * the raw version "{nano|micro}[up]time" will return a timestamp
812  * which is as precise as possible.  The "up" variants return the
813  * time relative to system boot, these are well suited for time
814  * interval measurements.
815  *
816  * Each cpu independantly maintains the current time of day, so all
817  * we need to do to protect ourselves from changes is to do a loop
818  * check on the seconds field changing out from under us.
819  *
820  * The system timer maintains a 32 bit count and due to various issues
821  * it is possible for the calculated delta to occassionally exceed
822  * sys_cputimer->freq.  If this occurs the sys_cputimer->freq64_nsec
823  * multiplication can easily overflow, so we deal with the case.  For
824  * uniformity we deal with the case in the usec case too.
825  */
826 void
827 getmicrouptime(struct timeval *tvp)
828 {
829         struct globaldata *gd = mycpu;
830         sysclock_t delta;
831
832         do {
833                 tvp->tv_sec = gd->gd_time_seconds;
834                 delta = gd->gd_hardclock.time - gd->gd_cpuclock_base;
835         } while (tvp->tv_sec != gd->gd_time_seconds);
836
837         if (delta >= sys_cputimer->freq) {
838                 tvp->tv_sec += delta / sys_cputimer->freq;
839                 delta %= sys_cputimer->freq;
840         }
841         tvp->tv_usec = (sys_cputimer->freq64_usec * delta) >> 32;
842         if (tvp->tv_usec >= 1000000) {
843                 tvp->tv_usec -= 1000000;
844                 ++tvp->tv_sec;
845         }
846 }
847
848 void
849 getnanouptime(struct timespec *tsp)
850 {
851         struct globaldata *gd = mycpu;
852         sysclock_t delta;
853
854         do {
855                 tsp->tv_sec = gd->gd_time_seconds;
856                 delta = gd->gd_hardclock.time - gd->gd_cpuclock_base;
857         } while (tsp->tv_sec != gd->gd_time_seconds);
858
859         if (delta >= sys_cputimer->freq) {
860                 tsp->tv_sec += delta / sys_cputimer->freq;
861                 delta %= sys_cputimer->freq;
862         }
863         tsp->tv_nsec = (sys_cputimer->freq64_nsec * delta) >> 32;
864 }
865
866 void
867 microuptime(struct timeval *tvp)
868 {
869         struct globaldata *gd = mycpu;
870         sysclock_t delta;
871
872         do {
873                 tvp->tv_sec = gd->gd_time_seconds;
874                 delta = sys_cputimer->count() - gd->gd_cpuclock_base;
875         } while (tvp->tv_sec != gd->gd_time_seconds);
876
877         if (delta >= sys_cputimer->freq) {
878                 tvp->tv_sec += delta / sys_cputimer->freq;
879                 delta %= sys_cputimer->freq;
880         }
881         tvp->tv_usec = (sys_cputimer->freq64_usec * delta) >> 32;
882 }
883
884 void
885 nanouptime(struct timespec *tsp)
886 {
887         struct globaldata *gd = mycpu;
888         sysclock_t delta;
889
890         do {
891                 tsp->tv_sec = gd->gd_time_seconds;
892                 delta = sys_cputimer->count() - gd->gd_cpuclock_base;
893         } while (tsp->tv_sec != gd->gd_time_seconds);
894
895         if (delta >= sys_cputimer->freq) {
896                 tsp->tv_sec += delta / sys_cputimer->freq;
897                 delta %= sys_cputimer->freq;
898         }
899         tsp->tv_nsec = (sys_cputimer->freq64_nsec * delta) >> 32;
900 }
901
902 /*
903  * realtime routines
904  */
905
906 void
907 getmicrotime(struct timeval *tvp)
908 {
909         struct globaldata *gd = mycpu;
910         struct timespec *bt;
911         sysclock_t delta;
912
913         do {
914                 tvp->tv_sec = gd->gd_time_seconds;
915                 delta = gd->gd_hardclock.time - gd->gd_cpuclock_base;
916         } while (tvp->tv_sec != gd->gd_time_seconds);
917
918         if (delta >= sys_cputimer->freq) {
919                 tvp->tv_sec += delta / sys_cputimer->freq;
920                 delta %= sys_cputimer->freq;
921         }
922         tvp->tv_usec = (sys_cputimer->freq64_usec * delta) >> 32;
923
924         bt = &basetime[basetime_index];
925         tvp->tv_sec += bt->tv_sec;
926         tvp->tv_usec += bt->tv_nsec / 1000;
927         while (tvp->tv_usec >= 1000000) {
928                 tvp->tv_usec -= 1000000;
929                 ++tvp->tv_sec;
930         }
931 }
932
933 void
934 getnanotime(struct timespec *tsp)
935 {
936         struct globaldata *gd = mycpu;
937         struct timespec *bt;
938         sysclock_t delta;
939
940         do {
941                 tsp->tv_sec = gd->gd_time_seconds;
942                 delta = gd->gd_hardclock.time - gd->gd_cpuclock_base;
943         } while (tsp->tv_sec != gd->gd_time_seconds);
944
945         if (delta >= sys_cputimer->freq) {
946                 tsp->tv_sec += delta / sys_cputimer->freq;
947                 delta %= sys_cputimer->freq;
948         }
949         tsp->tv_nsec = (sys_cputimer->freq64_nsec * delta) >> 32;
950
951         bt = &basetime[basetime_index];
952         tsp->tv_sec += bt->tv_sec;
953         tsp->tv_nsec += bt->tv_nsec;
954         while (tsp->tv_nsec >= 1000000000) {
955                 tsp->tv_nsec -= 1000000000;
956                 ++tsp->tv_sec;
957         }
958 }
959
960 static void
961 getnanotime_nbt(struct timespec *nbt, struct timespec *tsp)
962 {
963         struct globaldata *gd = mycpu;
964         sysclock_t delta;
965
966         do {
967                 tsp->tv_sec = gd->gd_time_seconds;
968                 delta = gd->gd_hardclock.time - gd->gd_cpuclock_base;
969         } while (tsp->tv_sec != gd->gd_time_seconds);
970
971         if (delta >= sys_cputimer->freq) {
972                 tsp->tv_sec += delta / sys_cputimer->freq;
973                 delta %= sys_cputimer->freq;
974         }
975         tsp->tv_nsec = (sys_cputimer->freq64_nsec * delta) >> 32;
976
977         tsp->tv_sec += nbt->tv_sec;
978         tsp->tv_nsec += nbt->tv_nsec;
979         while (tsp->tv_nsec >= 1000000000) {
980                 tsp->tv_nsec -= 1000000000;
981                 ++tsp->tv_sec;
982         }
983 }
984
985
986 void
987 microtime(struct timeval *tvp)
988 {
989         struct globaldata *gd = mycpu;
990         struct timespec *bt;
991         sysclock_t delta;
992
993         do {
994                 tvp->tv_sec = gd->gd_time_seconds;
995                 delta = sys_cputimer->count() - gd->gd_cpuclock_base;
996         } while (tvp->tv_sec != gd->gd_time_seconds);
997
998         if (delta >= sys_cputimer->freq) {
999                 tvp->tv_sec += delta / sys_cputimer->freq;
1000                 delta %= sys_cputimer->freq;
1001         }
1002         tvp->tv_usec = (sys_cputimer->freq64_usec * delta) >> 32;
1003
1004         bt = &basetime[basetime_index];
1005         tvp->tv_sec += bt->tv_sec;
1006         tvp->tv_usec += bt->tv_nsec / 1000;
1007         while (tvp->tv_usec >= 1000000) {
1008                 tvp->tv_usec -= 1000000;
1009                 ++tvp->tv_sec;
1010         }
1011 }
1012
1013 void
1014 nanotime(struct timespec *tsp)
1015 {
1016         struct globaldata *gd = mycpu;
1017         struct timespec *bt;
1018         sysclock_t delta;
1019
1020         do {
1021                 tsp->tv_sec = gd->gd_time_seconds;
1022                 delta = sys_cputimer->count() - gd->gd_cpuclock_base;
1023         } while (tsp->tv_sec != gd->gd_time_seconds);
1024
1025         if (delta >= sys_cputimer->freq) {
1026                 tsp->tv_sec += delta / sys_cputimer->freq;
1027                 delta %= sys_cputimer->freq;
1028         }
1029         tsp->tv_nsec = (sys_cputimer->freq64_nsec * delta) >> 32;
1030
1031         bt = &basetime[basetime_index];
1032         tsp->tv_sec += bt->tv_sec;
1033         tsp->tv_nsec += bt->tv_nsec;
1034         while (tsp->tv_nsec >= 1000000000) {
1035                 tsp->tv_nsec -= 1000000000;
1036                 ++tsp->tv_sec;
1037         }
1038 }
1039
1040 /*
1041  * note: this is not exactly synchronized with real time.  To do that we
1042  * would have to do what microtime does and check for a nanoseconds overflow.
1043  */
1044 time_t
1045 get_approximate_time_t(void)
1046 {
1047         struct globaldata *gd = mycpu;
1048         struct timespec *bt;
1049
1050         bt = &basetime[basetime_index];
1051         return(gd->gd_time_seconds + bt->tv_sec);
1052 }
1053
1054 int
1055 pps_ioctl(u_long cmd, caddr_t data, struct pps_state *pps)
1056 {
1057         pps_params_t *app;
1058         struct pps_fetch_args *fapi;
1059 #ifdef PPS_SYNC
1060         struct pps_kcbind_args *kapi;
1061 #endif
1062
1063         switch (cmd) {
1064         case PPS_IOC_CREATE:
1065                 return (0);
1066         case PPS_IOC_DESTROY:
1067                 return (0);
1068         case PPS_IOC_SETPARAMS:
1069                 app = (pps_params_t *)data;
1070                 if (app->mode & ~pps->ppscap)
1071                         return (EINVAL);
1072                 pps->ppsparam = *app;         
1073                 return (0);
1074         case PPS_IOC_GETPARAMS:
1075                 app = (pps_params_t *)data;
1076                 *app = pps->ppsparam;
1077                 app->api_version = PPS_API_VERS_1;
1078                 return (0);
1079         case PPS_IOC_GETCAP:
1080                 *(int*)data = pps->ppscap;
1081                 return (0);
1082         case PPS_IOC_FETCH:
1083                 fapi = (struct pps_fetch_args *)data;
1084                 if (fapi->tsformat && fapi->tsformat != PPS_TSFMT_TSPEC)
1085                         return (EINVAL);
1086                 if (fapi->timeout.tv_sec || fapi->timeout.tv_nsec)
1087                         return (EOPNOTSUPP);
1088                 pps->ppsinfo.current_mode = pps->ppsparam.mode;         
1089                 fapi->pps_info_buf = pps->ppsinfo;
1090                 return (0);
1091         case PPS_IOC_KCBIND:
1092 #ifdef PPS_SYNC
1093                 kapi = (struct pps_kcbind_args *)data;
1094                 /* XXX Only root should be able to do this */
1095                 if (kapi->tsformat && kapi->tsformat != PPS_TSFMT_TSPEC)
1096                         return (EINVAL);
1097                 if (kapi->kernel_consumer != PPS_KC_HARDPPS)
1098                         return (EINVAL);
1099                 if (kapi->edge & ~pps->ppscap)
1100                         return (EINVAL);
1101                 pps->kcmode = kapi->edge;
1102                 return (0);
1103 #else
1104                 return (EOPNOTSUPP);
1105 #endif
1106         default:
1107                 return (ENOTTY);
1108         }
1109 }
1110
1111 void
1112 pps_init(struct pps_state *pps)
1113 {
1114         pps->ppscap |= PPS_TSFMT_TSPEC;
1115         if (pps->ppscap & PPS_CAPTUREASSERT)
1116                 pps->ppscap |= PPS_OFFSETASSERT;
1117         if (pps->ppscap & PPS_CAPTURECLEAR)
1118                 pps->ppscap |= PPS_OFFSETCLEAR;
1119 }
1120
1121 void
1122 pps_event(struct pps_state *pps, sysclock_t count, int event)
1123 {
1124         struct globaldata *gd;
1125         struct timespec *tsp;
1126         struct timespec *osp;
1127         struct timespec *bt;
1128         struct timespec ts;
1129         sysclock_t *pcount;
1130 #ifdef PPS_SYNC
1131         sysclock_t tcount;
1132 #endif
1133         sysclock_t delta;
1134         pps_seq_t *pseq;
1135         int foff;
1136         int fhard;
1137
1138         gd = mycpu;
1139
1140         /* Things would be easier with arrays... */
1141         if (event == PPS_CAPTUREASSERT) {
1142                 tsp = &pps->ppsinfo.assert_timestamp;
1143                 osp = &pps->ppsparam.assert_offset;
1144                 foff = pps->ppsparam.mode & PPS_OFFSETASSERT;
1145                 fhard = pps->kcmode & PPS_CAPTUREASSERT;
1146                 pcount = &pps->ppscount[0];
1147                 pseq = &pps->ppsinfo.assert_sequence;
1148         } else {
1149                 tsp = &pps->ppsinfo.clear_timestamp;
1150                 osp = &pps->ppsparam.clear_offset;
1151                 foff = pps->ppsparam.mode & PPS_OFFSETCLEAR;
1152                 fhard = pps->kcmode & PPS_CAPTURECLEAR;
1153                 pcount = &pps->ppscount[1];
1154                 pseq = &pps->ppsinfo.clear_sequence;
1155         }
1156
1157         /* Nothing really happened */
1158         if (*pcount == count)
1159                 return;
1160
1161         *pcount = count;
1162
1163         do {
1164                 ts.tv_sec = gd->gd_time_seconds;
1165                 delta = count - gd->gd_cpuclock_base;
1166         } while (ts.tv_sec != gd->gd_time_seconds);
1167
1168         if (delta >= sys_cputimer->freq) {
1169                 ts.tv_sec += delta / sys_cputimer->freq;
1170                 delta %= sys_cputimer->freq;
1171         }
1172         ts.tv_nsec = (sys_cputimer->freq64_nsec * delta) >> 32;
1173         bt = &basetime[basetime_index];
1174         ts.tv_sec += bt->tv_sec;
1175         ts.tv_nsec += bt->tv_nsec;
1176         while (ts.tv_nsec >= 1000000000) {
1177                 ts.tv_nsec -= 1000000000;
1178                 ++ts.tv_sec;
1179         }
1180
1181         (*pseq)++;
1182         *tsp = ts;
1183
1184         if (foff) {
1185                 timespecadd(tsp, osp);
1186                 if (tsp->tv_nsec < 0) {
1187                         tsp->tv_nsec += 1000000000;
1188                         tsp->tv_sec -= 1;
1189                 }
1190         }
1191 #ifdef PPS_SYNC
1192         if (fhard) {
1193                 /* magic, at its best... */
1194                 tcount = count - pps->ppscount[2];
1195                 pps->ppscount[2] = count;
1196                 if (tcount >= sys_cputimer->freq) {
1197                         delta = (1000000000 * (tcount / sys_cputimer->freq) +
1198                                  sys_cputimer->freq64_nsec * 
1199                                  (tcount % sys_cputimer->freq)) >> 32;
1200                 } else {
1201                         delta = (sys_cputimer->freq64_nsec * tcount) >> 32;
1202                 }
1203                 hardpps(tsp, delta);
1204         }
1205 #endif
1206 }
1207