2 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
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.
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
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.
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
71 * From: @(#)kern_clock.c 8.5 (Berkeley) 1/21/94
72 * $FreeBSD: src/sys/kern/kern_timeout.c,v 1.59.2.1 2001/11/13 18:24:52 archie Exp $
73 * $DragonFly: src/sys/kern/kern_timeout.c,v 1.27 2007/11/14 18:27:52 swildner Exp $
76 * DRAGONFLY BGL STATUS
78 * All the API functions should be MP safe.
80 * The callback functions will be flagged as being MP safe if the
81 * timeout structure is initialized with callout_init_mp() instead of
84 * The helper threads cannot be made preempt-capable until after we
85 * clean up all the uses of splsoftclock() and related interlocks (which
86 * require the related functions to be MP safe as well).
89 * The callout mechanism is based on the work of Adam M. Costello and
90 * George Varghese, published in a technical report entitled "Redesigning
91 * the BSD Callout and Timer Facilities" and modified slightly for inclusion
92 * in FreeBSD by Justin T. Gibbs. The original work on the data structures
93 * used in this implementation was published by G. Varghese and T. Lauck in
94 * the paper "Hashed and Hierarchical Timing Wheels: Data Structures for
95 * the Efficient Implementation of a Timer Facility" in the Proceedings of
96 * the 11th ACM Annual Symposium on Operating Systems Principles,
97 * Austin, Texas Nov 1987.
99 * The per-cpu augmentation was done by Matthew Dillon.
102 #include <sys/param.h>
103 #include <sys/systm.h>
104 #include <sys/callout.h>
105 #include <sys/kernel.h>
106 #include <sys/interrupt.h>
107 #include <sys/thread.h>
109 #include <sys/thread2.h>
110 #include <sys/mplock2.h>
112 #ifndef MAX_SOFTCLOCK_STEPS
113 #define MAX_SOFTCLOCK_STEPS 100 /* Maximum allowed value of steps. */
117 struct softclock_pcpu {
118 struct callout_tailq *callwheel;
119 struct callout * volatile next;
120 struct callout *running;/* currently running callout */
121 int softticks; /* softticks index */
122 int curticks; /* per-cpu ticks counter */
124 struct thread thread;
128 typedef struct softclock_pcpu *softclock_pcpu_t;
132 * allocate more timeout table slots when table overflows.
134 static MALLOC_DEFINE(M_CALLOUT, "callout", "callout structures");
135 static int callwheelsize;
136 static int callwheelbits;
137 static int callwheelmask;
138 static struct softclock_pcpu softclock_pcpu_ary[MAXCPU];
140 static void softclock_handler(void *arg);
143 swi_softclock_setup(void *arg)
149 * Figure out how large a callwheel we need. It must be a power of 2.
153 while (callwheelsize < ncallout) {
157 callwheelmask = callwheelsize - 1;
160 * Initialize per-cpu data structures.
162 for (cpu = 0; cpu < ncpus; ++cpu) {
165 sc = &softclock_pcpu_ary[cpu];
167 sc->callwheel = kmalloc(sizeof(*sc->callwheel) * callwheelsize,
168 M_CALLOUT, M_WAITOK|M_ZERO);
169 for (i = 0; i < callwheelsize; ++i)
170 TAILQ_INIT(&sc->callwheel[i]);
173 * Mark the softclock handler as being an interrupt thread
174 * even though it really isn't, but do not allow it to
175 * preempt other threads (do not assign td_preemptable).
177 * Kernel code now assumes that callouts do not preempt
178 * the cpu they were scheduled on.
180 lwkt_create(softclock_handler, sc, NULL,
181 &sc->thread, TDF_STOPREQ | TDF_INTTHREAD,
182 cpu, "softclock %d", cpu);
187 * Must occur after ncpus has been initialized.
189 SYSINIT(softclock_setup, SI_BOOT2_SOFTCLOCK, SI_ORDER_SECOND,
190 swi_softclock_setup, NULL);
193 * This routine is called from the hardclock() (basically a FASTint/IPI) on
194 * each cpu in the system. sc->curticks is this cpu's notion of the timebase.
195 * It IS NOT NECESSARILY SYNCHRONIZED WITH 'ticks'! sc->softticks is where
196 * the callwheel is currently indexed.
198 * WARNING! The MP lock is not necessarily held on call, nor can it be
201 * sc->softticks is adjusted by either this routine or our helper thread
202 * depending on whether the helper thread is running or not.
205 hardclock_softtick(globaldata_t gd)
209 sc = &softclock_pcpu_ary[gd->gd_cpuid];
213 if (sc->softticks == sc->curticks) {
215 * in sync, only wakeup the thread if there is something to
218 if (TAILQ_FIRST(&sc->callwheel[sc->softticks & callwheelmask]))
221 lwkt_schedule(&sc->thread);
227 * out of sync, wakeup the thread unconditionally so it can
231 lwkt_schedule(&sc->thread);
236 * This procedure is the main loop of our per-cpu helper thread. The
237 * sc->isrunning flag prevents us from racing hardclock_softtick() and
238 * a critical section is sufficient to interlock sc->curticks and protect
239 * us from remote IPI's / list removal.
241 * The thread starts with the MP lock released and not in a critical
242 * section. The loop itself is MP safe while individual callbacks
243 * may or may not be, so we obtain or release the MP lock as appropriate.
246 softclock_handler(void *arg)
250 struct callout_tailq *bucket;
251 void (*c_func)(void *);
257 lwkt_setpri_self(TDPRI_SOFT_NORM);
262 while (sc->softticks != (int)(sc->curticks + 1)) {
263 bucket = &sc->callwheel[sc->softticks & callwheelmask];
265 for (c = TAILQ_FIRST(bucket); c; c = sc->next) {
266 if (c->c_time != sc->softticks) {
267 sc->next = TAILQ_NEXT(c, c_links.tqe);
271 if (c->c_flags & CALLOUT_MPSAFE) {
278 * The request might be removed while we
279 * are waiting to get the MP lock. If it
280 * was removed sc->next will point to the
281 * next valid request or NULL, loop up.
292 sc->next = TAILQ_NEXT(c, c_links.tqe);
293 TAILQ_REMOVE(bucket, c, c_links.tqe);
299 KKASSERT(c->c_flags & CALLOUT_DID_INIT);
300 c->c_flags &= ~CALLOUT_PENDING;
305 /* NOTE: list may have changed */
310 lwkt_deschedule_self(&sc->thread); /* == curthread */
317 * New interface; clients allocate their own callout structures.
319 * callout_reset() - establish or change a timeout
320 * callout_stop() - disestablish a timeout
321 * callout_init() - initialize a callout structure so that it can
322 * safely be passed to callout_reset() and callout_stop()
323 * callout_init_mp() - same but any installed functions must be MP safe.
325 * <sys/callout.h> defines three convenience macros:
327 * callout_active() - returns truth if callout has not been serviced
328 * callout_pending() - returns truth if callout is still waiting for timeout
329 * callout_deactivate() - marks the callout as having been serviced
333 * Start or restart a timeout. Install the callout structure in the
334 * callwheel. Callers may legally pass any value, even if 0 or negative,
335 * but since the sc->curticks index may have already been processed a
336 * minimum timeout of 1 tick will be enforced.
338 * The callout is installed on and will be processed on the current cpu's
341 * WARNING! This function may be called from any cpu but the caller must
342 * serialize callout_stop() and callout_reset() calls on the passed
343 * structure regardless of cpu.
346 callout_reset(struct callout *c, int to_ticks, void (*ftn)(void *),
353 if ((c->c_flags & CALLOUT_DID_INIT) == 0) {
356 "callout_reset(%p) from %p: callout was not initialized\n",
357 c, ((int **)&c)[-1]);
362 sc = &softclock_pcpu_ary[gd->gd_cpuid];
365 if (c->c_flags & CALLOUT_ACTIVE)
372 c->c_flags |= (CALLOUT_ACTIVE | CALLOUT_PENDING);
374 c->c_time = sc->curticks + to_ticks;
379 TAILQ_INSERT_TAIL(&sc->callwheel[c->c_time & callwheelmask],
385 * Stop a running timer. WARNING! If called on a cpu other then the one
386 * the callout was started on this function will liveloop on its IPI to
387 * the target cpu to process the request. It is possible for the callout
388 * to execute in that case.
390 * WARNING! This function may be called from any cpu but the caller must
391 * serialize callout_stop() and callout_reset() calls on the passed
392 * structure regardless of cpu.
394 * WARNING! This routine may be called from an IPI
396 * WARNING! This function can return while it's c_func is still running
397 * in the callout thread, a secondary check may be needed.
400 callout_stop(struct callout *c)
402 globaldata_t gd = mycpu;
409 if ((c->c_flags & CALLOUT_DID_INIT) == 0) {
412 "callout_stop(%p) from %p: callout was not initialized\n",
413 c, ((int **)&c)[-1]);
420 * Don't attempt to delete a callout that's not on the queue. The
421 * callout may not have a cpu assigned to it. Callers do not have
422 * to be on the issuing cpu but must still serialize access to the
425 * We are not cpu-localized here and cannot safely modify the
426 * flags field in the callout structure. Note that most of the
427 * time CALLOUT_ACTIVE will be 0 if CALLOUT_PENDING is also 0.
429 * If we race another cpu's dispatch of this callout it is possible
430 * for CALLOUT_ACTIVE to be set with CALLOUT_PENDING unset. This
431 * will cause us to fall through and synchronize with the other
434 if ((c->c_flags & CALLOUT_PENDING) == 0) {
436 if ((c->c_flags & CALLOUT_ACTIVE) == 0) {
440 if (c->c_gd == NULL || c->c_gd == gd) {
441 c->c_flags &= ~CALLOUT_ACTIVE;
445 /* fall-through to the cpu-localization code. */
447 c->c_flags &= ~CALLOUT_ACTIVE;
453 if ((tgd = c->c_gd) != gd) {
455 * If the callout is owned by a different CPU we have to
456 * execute the function synchronously on the target cpu.
460 cpu_ccfence(); /* don't let tgd alias c_gd */
461 seq = lwkt_send_ipiq(tgd, (void *)callout_stop, c);
462 lwkt_wait_ipiq(tgd, seq);
467 * If the callout is owned by the same CPU we can
468 * process it directly, but if we are racing our helper
469 * thread (sc->next), we have to adjust sc->next. The
470 * race is interlocked by a critical section.
472 sc = &softclock_pcpu_ary[gd->gd_cpuid];
474 c->c_flags &= ~(CALLOUT_ACTIVE | CALLOUT_PENDING);
476 sc->next = TAILQ_NEXT(c, c_links.tqe);
478 TAILQ_REMOVE(&sc->callwheel[c->c_time & callwheelmask],
487 * Terminate a callout
489 * This function will stop any pending callout and also block while the
490 * callout's function is running. It should only be used in cases where
491 * no deadlock is possible (due to the callout function acquiring locks
492 * that the current caller of callout_terminate() already holds), when
493 * the caller is ready to destroy the callout structure.
495 * This function clears the CALLOUT_DID_INIT flag.
497 * lwkt_token locks are ok.
500 callout_terminate(struct callout *c)
504 if (c->c_flags & CALLOUT_DID_INIT) {
506 sc = &softclock_pcpu_ary[c->c_gd->gd_cpuid];
507 if (sc->running == c) {
508 kprintf("callout_terminate: race averted func %p\n",
510 while (sc->running == c)
511 tsleep(&sc->running, 0, "crace", 1);
513 KKASSERT((c->c_flags & (CALLOUT_PENDING|CALLOUT_ACTIVE)) == 0);
514 c->c_flags &= ~CALLOUT_DID_INIT;
519 * Prepare a callout structure for use by callout_reset() and/or
520 * callout_stop(). The MP version of this routine requires that the callback
521 * function installed by callout_reset() be MP safe.
523 * The init functions can be called from any cpu and do not have to be
524 * called from the cpu that the timer will eventually run on.
527 callout_init(struct callout *c)
530 c->c_flags = CALLOUT_DID_INIT;
534 callout_init_mp(struct callout *c)
537 c->c_flags |= CALLOUT_MPSAFE;
540 /* What, are you joking? This is nuts! -Matt */
542 #ifdef APM_FIXUP_CALLTODO
544 * Adjust the kernel calltodo timeout list. This routine is used after
545 * an APM resume to recalculate the calltodo timer list values with the
546 * number of hz's we have been sleeping. The next hardclock() will detect
547 * that there are fired timers and run softclock() to execute them.
549 * Please note, I have not done an exhaustive analysis of what code this
550 * might break. I am motivated to have my select()'s and alarm()'s that
551 * have expired during suspend firing upon resume so that the applications
552 * which set the timer can do the maintanence the timer was for as close
553 * as possible to the originally intended time. Testing this code for a
554 * week showed that resuming from a suspend resulted in 22 to 25 timers
555 * firing, which seemed independant on whether the suspend was 2 hours or
556 * 2 days. Your milage may vary. - Ken Key <key@cs.utk.edu>
559 adjust_timeout_calltodo(struct timeval *time_change)
562 unsigned long delta_ticks;
565 * How many ticks were we asleep?
566 * (stolen from tvtohz()).
569 /* Don't do anything */
570 if (time_change->tv_sec < 0)
572 else if (time_change->tv_sec <= LONG_MAX / 1000000)
573 delta_ticks = (time_change->tv_sec * 1000000 +
574 time_change->tv_usec + (tick - 1)) / tick + 1;
575 else if (time_change->tv_sec <= LONG_MAX / hz)
576 delta_ticks = time_change->tv_sec * hz +
577 (time_change->tv_usec + (tick - 1)) / tick + 1;
579 delta_ticks = LONG_MAX;
581 if (delta_ticks > INT_MAX)
582 delta_ticks = INT_MAX;
585 * Now rip through the timer calltodo list looking for timers
589 /* don't collide with softclock() */
591 for (p = calltodo.c_next; p != NULL; p = p->c_next) {
592 p->c_time -= delta_ticks;
594 /* Break if the timer had more time on it than delta_ticks */
598 /* take back the ticks the timer didn't use (p->c_time <= 0) */
599 delta_ticks = -p->c_time;
605 #endif /* APM_FIXUP_CALLTODO */