sys/sys/_callout.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1990, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)callout.h   8.2 (Berkeley) 1/21/94
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _SYS__CALLOUT_H
  41 #define _SYS__CALLOUT_H
  42
  43 #include <sys/queue.h>
  44
  45 struct lock_object;
  46
  47 LIST_HEAD(callout_list, callout);
  48 SLIST_HEAD(callout_slist, callout);
  49 TAILQ_HEAD(callout_tailq, callout);
  50
  51 typedef void callout_func_t(void *);
  52
  53 struct callout {
  54         union {
  55                 LIST_ENTRY(callout) le;
  56                 SLIST_ENTRY(callout) sle;
  57                 TAILQ_ENTRY(callout) tqe;
  58         } c_links;
  59         sbintime_t c_time;                      /* ticks to the event */
  60         sbintime_t c_precision;                 /* delta allowed wrt opt */
  61         void    *c_arg;                         /* function argument */
  62         callout_func_t *c_func;                 /* function to call */
  63         struct lock_object *c_lock;             /* lock to handle */
  64         short   c_flags;                        /* User State */
  65         short   c_iflags;                       /* Internal State */
  66         volatile int c_cpu;                     /* CPU we're scheduled on */
  67 };
  68
  69 #endif