sys/sys/callout.h

   1 /*-
   2  * Copyright (c) 1990, 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.
   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  * 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.
  21  *
  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
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)callout.h   8.2 (Berkeley) 1/21/94
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _SYS_CALLOUT_H_
  39 #define _SYS_CALLOUT_H_
  40
  41 #include <sys/queue.h>
  42
  43 struct mtx;
  44
  45 SLIST_HEAD(callout_list, callout);
  46 TAILQ_HEAD(callout_tailq, callout);
  47
  48 struct callout {
  49         union {
  50                 SLIST_ENTRY(callout) sle;
  51                 TAILQ_ENTRY(callout) tqe;
  52         } c_links;
  53         int     c_time;                         /* ticks to the event */
  54         void    *c_arg;                         /* function argument */
  55         void    (*c_func)(void *);      /* function to call */
  56         struct mtx *c_mtx;                      /* mutex to lock */
  57         int     c_flags;                        /* state of this entry */
  58 };
  59
  60 #define CALLOUT_LOCAL_ALLOC     0x0001 /* was allocated from callfree */
  61 #define CALLOUT_ACTIVE          0x0002 /* callout is currently active */
  62 #define CALLOUT_PENDING         0x0004 /* callout is waiting for timeout */
  63 #define CALLOUT_MPSAFE          0x0008 /* callout handler is mp safe */
  64 #define CALLOUT_RETURNUNLOCKED  0x0010 /* handler returns with mtx unlocked */
  65
  66 struct callout_handle {
  67         struct callout *callout;
  68 };
  69
  70 #ifdef _KERNEL
  71 extern struct callout_list callfree;
  72 extern struct callout *callout;
  73 extern int ncallout;
  74 extern struct callout_tailq *callwheel;
  75 extern int callwheelsize, callwheelbits, callwheelmask, softticks;
  76 extern struct mtx callout_lock;
  77
  78 #define callout_active(c)       ((c)->c_flags & CALLOUT_ACTIVE)
  79 #define callout_deactivate(c)   ((c)->c_flags &= ~CALLOUT_ACTIVE)
  80 #define callout_drain(c)        _callout_stop_safe(c, 1)
  81 void    callout_init(struct callout *, int);
  82 void    callout_init_mtx(struct callout *, struct mtx *, int);
  83 #define callout_pending(c)      ((c)->c_flags & CALLOUT_PENDING)
  84 int     callout_reset(struct callout *, int, void (*)(void *), void *);
  85 #define callout_stop(c)         _callout_stop_safe(c, 0)
  86 int     _callout_stop_safe(struct callout *, int);
  87
  88 #endif
  89
  90 #endif /* _SYS_CALLOUT_H_ */