kern_timeout.c revision 1.3
1 /* $NetBSD: kern_timeout.c,v 1.3 2003/02/10 19:18:56 drochner Exp $ */ 2 3 /*- 4 * Copyright (c) 2003 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 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 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 /* 40 * Copyright (c) 2001 Thomas Nordin <nordin (at) openbsd.org> 41 * Copyright (c) 2000-2001 Artur Grabowski <art (at) openbsd.org> 42 * All rights reserved. 43 * 44 * Redistribution and use in source and binary forms, with or without 45 * modification, are permitted provided that the following conditions 46 * are met: 47 * 48 * 1. Redistributions of source code must retain the above copyright 49 * notice, this list of conditions and the following disclaimer. 50 * 2. Redistributions in binary form must reproduce the above copyright 51 * notice, this list of conditions and the following disclaimer in the 52 * documentation and/or other materials provided with the distribution. 53 * 3. The name of the author may not be used to endorse or promote products 54 * derived from this software without specific prior written permission. 55 * 56 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 57 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 58 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 59 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 60 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 61 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 62 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 63 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 64 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 65 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 66 */ 67 68 /* 69 * Adapted from OpenBSD: kern_timeout.c,v 1.15 2002/12/08 04:21:07 art Exp, 70 * modified to match NetBSD's pre-existing callout API. 71 */ 72 73 #include <sys/param.h> 74 #include <sys/systm.h> 75 #include <sys/kernel.h> 76 #include <sys/lock.h> 77 #include <sys/callout.h> 78 79 #ifdef DDB 80 #include <machine/db_machdep.h> 81 #include <ddb/db_interface.h> 82 #include <ddb/db_access.h> 83 #include <ddb/db_sym.h> 84 #include <ddb/db_output.h> 85 #endif 86 87 /* 88 * Timeouts are kept in a hierarchical timing wheel. The c_time is the value 89 * of the global variable "hardclock_ticks" when the timeout should be called. 90 * There are four levels with 256 buckets each. See 'Scheme 7' in 91 * "Hashed and Hierarchical Timing Wheels: Efficient Data Structures for 92 * Implementing a Timer Facility" by George Varghese and Tony Lauck. 93 */ 94 #define BUCKETS 1024 95 #define WHEELSIZE 256 96 #define WHEELMASK 255 97 #define WHEELBITS 8 98 99 static struct callout_circq timeout_wheel[BUCKETS]; /* Queues of timeouts */ 100 static struct callout_circq timeout_todo; /* Worklist */ 101 102 #define MASKWHEEL(wheel, time) (((time) >> ((wheel)*WHEELBITS)) & WHEELMASK) 103 104 #define BUCKET(rel, abs) \ 105 (((rel) <= (1 << (2*WHEELBITS))) \ 106 ? ((rel) <= (1 << WHEELBITS)) \ 107 ? &timeout_wheel[MASKWHEEL(0, (abs))] \ 108 : &timeout_wheel[MASKWHEEL(1, (abs)) + WHEELSIZE] \ 109 : ((rel) <= (1 << (3*WHEELBITS))) \ 110 ? &timeout_wheel[MASKWHEEL(2, (abs)) + 2*WHEELSIZE] \ 111 : &timeout_wheel[MASKWHEEL(3, (abs)) + 3*WHEELSIZE]) 112 113 #define MOVEBUCKET(wheel, time) \ 114 CIRCQ_APPEND(&timeout_todo, \ 115 &timeout_wheel[MASKWHEEL((wheel), (time)) + (wheel)*WHEELSIZE]) 116 117 /* 118 * All wheels are locked with the same lock (which must also block out all 119 * interrupts). 120 */ 121 static struct simplelock callout_slock; 122 123 #define CALLOUT_LOCK(s) \ 124 do { \ 125 s = splsched(); \ 126 simple_lock(&callout_slock); \ 127 } while (/*CONSTCOND*/0) 128 129 #define CALLOUT_UNLOCK(s) \ 130 do { \ 131 simple_unlock(&callout_slock); \ 132 splx((s)); \ 133 } while (/*CONSTCOND*/0) 134 135 /* 136 * Circular queue definitions. 137 */ 138 139 #define CIRCQ_INIT(elem) \ 140 do { \ 141 (elem)->cq_next = (elem); \ 142 (elem)->cq_prev = (elem); \ 143 } while (/*CONSTCOND*/0) 144 145 #define CIRCQ_INSERT(elem, list) \ 146 do { \ 147 (elem)->cq_prev = (list)->cq_prev; \ 148 (elem)->cq_next = (list); \ 149 (list)->cq_prev->cq_next = (elem); \ 150 (list)->cq_prev = (elem); \ 151 } while (/*CONSTCOND*/0) 152 153 #define CIRCQ_APPEND(fst, snd) \ 154 do { \ 155 if (!CIRCQ_EMPTY(snd)) { \ 156 (fst)->cq_prev->cq_next = (snd)->cq_next; \ 157 (snd)->cq_next->cq_prev = (fst)->cq_prev; \ 158 (snd)->cq_prev->cq_next = (fst); \ 159 (fst)->cq_prev = (snd)->cq_prev; \ 160 CIRCQ_INIT(snd); \ 161 } \ 162 } while (/*CONSTCOND*/0) 163 164 #define CIRCQ_REMOVE(elem) \ 165 do { \ 166 (elem)->cq_next->cq_prev = (elem)->cq_prev; \ 167 (elem)->cq_prev->cq_next = (elem)->cq_next; \ 168 } while (/*CONSTCOND*/0) 169 170 #define CIRCQ_FIRST(elem) ((elem)->cq_next) 171 172 #define CIRCQ_EMPTY(elem) (CIRCQ_FIRST(elem) == (elem)) 173 174 /* 175 * Some of the "math" in here is a bit tricky. 176 * 177 * We have to beware of wrapping ints. 178 * We use the fact that any element added to the queue must be added with a 179 * positive time. That means that any element `to' on the queue cannot be 180 * scheduled to timeout further in time than INT_MAX, but c->c_time can 181 * be positive or negative so comparing it with anything is dangerous. 182 * The only way we can use the c->c_time value in any predictable way 183 * is when we caluculate how far in the future `to' will timeout - 184 * "c->c_time - hardclock_ticks". The result will always be positive for 185 * future timeouts and 0 or negative for due timeouts. 186 */ 187 188 /* 189 * callout_startup: 190 * 191 * Initialize the callout facility, called at system startup time. 192 */ 193 void 194 callout_startup(void) 195 { 196 int b; 197 198 CIRCQ_INIT(&timeout_todo); 199 for (b = 0; b < BUCKETS; b++) 200 CIRCQ_INIT(&timeout_wheel[b]); 201 simple_lock_init(&callout_slock); 202 } 203 204 /* 205 * callout_init: 206 * 207 * Initialize a callout structure. 208 */ 209 void 210 callout_init(struct callout *c) 211 { 212 213 memset(c, 0, sizeof(*c)); 214 } 215 216 /* 217 * callout_setfunc: 218 * 219 * Initialize a callout structure and set the function and 220 * argument. 221 */ 222 void 223 callout_setfunc(struct callout *c, void (*func)(void *), void *arg) 224 { 225 226 memset(c, 0, sizeof(*c)); 227 c->c_func = func; 228 c->c_arg = arg; 229 } 230 231 /* 232 * callout_reset: 233 * 234 * Reset a callout structure with a new function and argument, and 235 * schedule it to run. 236 */ 237 void 238 callout_reset(struct callout *c, int to_ticks, void (*func)(void *), void *arg) 239 { 240 int s, old_time; 241 242 KASSERT(to_ticks >= 0); 243 244 CALLOUT_LOCK(s); 245 246 /* Initialize the time here, it won't change. */ 247 old_time = c->c_time; 248 c->c_time = to_ticks + hardclock_ticks; 249 c->c_flags &= ~CALLOUT_FIRED; 250 251 c->c_func = func; 252 c->c_arg = arg; 253 254 /* 255 * If this timeout is already scheduled and now is moved 256 * earlier, reschedule it now. Otherwise leave it in place 257 * and let it be rescheduled later. 258 */ 259 if (callout_pending(c)) { 260 if (c->c_time < old_time) { 261 CIRCQ_REMOVE(&c->c_list); 262 CIRCQ_INSERT(&c->c_list, &timeout_todo); 263 } 264 } else { 265 c->c_flags |= CALLOUT_PENDING; 266 CIRCQ_INSERT(&c->c_list, &timeout_todo); 267 } 268 269 CALLOUT_UNLOCK(s); 270 } 271 272 /* 273 * callout_schedule: 274 * 275 * Schedule a callout to run. The function and argument must 276 * already be set in the callout structure. 277 */ 278 void 279 callout_schedule(struct callout *c, int to_ticks) 280 { 281 int s, old_time; 282 283 KASSERT(to_ticks >= 0); 284 285 CALLOUT_LOCK(s); 286 287 /* Initialize the time here, it won't change. */ 288 old_time = c->c_time; 289 c->c_time = to_ticks + hardclock_ticks; 290 c->c_flags &= ~CALLOUT_FIRED; 291 292 /* 293 * If this timeout is already scheduled and now is moved 294 * earlier, reschedule it now. Otherwise leave it in place 295 * and let it be rescheduled later. 296 */ 297 if (callout_pending(c)) { 298 if (c->c_time < old_time) { 299 CIRCQ_REMOVE(&c->c_list); 300 CIRCQ_INSERT(&c->c_list, &timeout_todo); 301 } 302 } else { 303 c->c_flags |= CALLOUT_PENDING; 304 CIRCQ_INSERT(&c->c_list, &timeout_todo); 305 } 306 307 CALLOUT_UNLOCK(s); 308 } 309 310 /* 311 * callout_stop: 312 * 313 * Cancel a pending callout. 314 */ 315 void 316 callout_stop(struct callout *c) 317 { 318 int s; 319 320 CALLOUT_LOCK(s); 321 322 if (callout_pending(c)) 323 CIRCQ_REMOVE(&c->c_list); 324 325 c->c_flags &= ~(CALLOUT_PENDING|CALLOUT_FIRED); 326 327 CALLOUT_UNLOCK(s); 328 } 329 330 /* 331 * This is called from hardclock() once every tick. 332 * We return !0 if we need to schedule a softclock. 333 */ 334 int 335 callout_hardclock(void) 336 { 337 int s; 338 339 CALLOUT_LOCK(s); 340 341 MOVEBUCKET(0, hardclock_ticks); 342 if (MASKWHEEL(0, hardclock_ticks) == 0) { 343 MOVEBUCKET(1, hardclock_ticks); 344 if (MASKWHEEL(1, hardclock_ticks) == 0) { 345 MOVEBUCKET(2, hardclock_ticks); 346 if (MASKWHEEL(2, hardclock_ticks) == 0) 347 MOVEBUCKET(3, hardclock_ticks); 348 } 349 } 350 351 CALLOUT_UNLOCK(s); 352 353 return (!CIRCQ_EMPTY(&timeout_todo)); 354 } 355 356 /* ARGSUSED */ 357 void 358 softclock(void *v) 359 { 360 struct callout *c; 361 void (*func)(void *); 362 void *arg; 363 int s; 364 365 CALLOUT_LOCK(s); 366 367 while (!CIRCQ_EMPTY(&timeout_todo)) { 368 369 c = (struct callout *)CIRCQ_FIRST(&timeout_todo); /* XXX */ 370 CIRCQ_REMOVE(&c->c_list); 371 372 /* If due run it, otherwise insert it into the right bucket. */ 373 if (c->c_time - hardclock_ticks > 0) { 374 CIRCQ_INSERT(&c->c_list, 375 BUCKET((c->c_time - hardclock_ticks), c->c_time)); 376 } else { 377 #ifdef DEBUG /* XXX evcnt */ 378 if (c->c_time - hardclock_ticks < 0) 379 printf("timeout delayed %d\n", c->c_time - 380 hardclock_ticks); 381 #endif 382 c->c_flags = (c->c_flags & ~CALLOUT_PENDING) | 383 CALLOUT_FIRED; 384 385 func = c->c_func; 386 arg = c->c_arg; 387 388 CALLOUT_UNLOCK(s); 389 (*func)(arg); 390 CALLOUT_LOCK(s); 391 } 392 } 393 394 CALLOUT_UNLOCK(s); 395 } 396 397 #ifdef DDB 398 static void 399 db_show_callout_bucket(struct callout_circq *bucket) 400 { 401 struct callout *c; 402 struct callout_circq *p; 403 db_expr_t offset; 404 char *name; 405 406 for (p = CIRCQ_FIRST(bucket); p != bucket; p = CIRCQ_FIRST(p)) { 407 c = (struct callout *)p; /* XXX */ 408 db_find_sym_and_offset((db_addr_t)c->c_func, &name, &offset); 409 name = name ? name : "?"; 410 #ifdef _LP64 411 #define POINTER_WIDTH "%16lx" 412 #else 413 #define POINTER_WIDTH "%8lx" 414 #endif 415 db_printf("%9d %2d/%-4d " POINTER_WIDTH " %s\n", 416 c->c_time - hardclock_ticks, 417 (int)((bucket - timeout_wheel) / WHEELSIZE), 418 (int)(bucket - timeout_wheel), (u_long) c->c_arg, name); 419 } 420 } 421 422 void 423 db_show_callout(db_expr_t addr, int haddr, db_expr_t count, char *modif) 424 { 425 int b; 426 427 db_printf("hardclock_ticks now: %d\n", hardclock_ticks); 428 #ifdef _LP64 429 db_printf(" ticks wheel arg func\n"); 430 #else 431 db_printf(" ticks wheel arg func\n"); 432 #endif 433 434 /* 435 * Don't lock the callwheel; all the other CPUs are paused 436 * anyhow, and we might be called in a circumstance where 437 * some other CPU was paused while holding the lock. 438 */ 439 440 db_show_callout_bucket(&timeout_todo); 441 for (b = 0; b < BUCKETS; b++) 442 db_show_callout_bucket(&timeout_wheel[b]); 443 } 444 #endif /* DDB */ 445
Indexes created Sat Sep 20 22:09:52 GMT 2025