The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/callout.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    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: stable/10/sys/sys/callout.h 337034 2018-08-01 10:34:53Z hselasky $
   36  */
   37 
   38 #ifndef _SYS_CALLOUT_H_
   39 #define _SYS_CALLOUT_H_
   40 
   41 #include <sys/_callout.h>
   42 
   43 #define CALLOUT_LOCAL_ALLOC     0x0001 /* was allocated from callfree */
   44 #define CALLOUT_ACTIVE          0x0002 /* callout is currently active */
   45 #define CALLOUT_PENDING         0x0004 /* callout is waiting for timeout */
   46 #define CALLOUT_MPSAFE          0x0008 /* deprecated */
   47 #define CALLOUT_RETURNUNLOCKED  0x0010 /* handler returns with mtx unlocked */
   48 #define CALLOUT_SHAREDLOCK      0x0020 /* callout lock held in shared mode */
   49 #define CALLOUT_DFRMIGRATION    0x0040 /* callout in deferred migration mode */
   50 #define CALLOUT_PROCESSED       0x0080 /* callout in wheel or processing list? */
   51 #define CALLOUT_DIRECT          0x0100 /* allow exec from hw int context */
   52 
   53 #define C_DIRECT_EXEC           0x0001 /* direct execution of callout */
   54 #define C_PRELBITS              7
   55 #define C_PRELRANGE             ((1 << C_PRELBITS) - 1)
   56 #define C_PREL(x)               (((x) + 1) << 1)
   57 #define C_PRELGET(x)            (int)((((x) >> 1) & C_PRELRANGE) - 1)
   58 #define C_HARDCLOCK             0x0100 /* align to hardclock() calls */
   59 #define C_ABSOLUTE              0x0200 /* event time is absolute. */
   60 #define C_PRECALC               0x0400 /* event time is pre-calculated. */
   61 #define C_CATCH                 0x0800 /* catch signals, used by pause_sbt(9) */
   62 
   63 struct callout_handle {
   64         struct callout *callout;
   65 };
   66 
   67 /* Flags for callout_stop_safe() */
   68 #define CS_DRAIN                0x0001 /* callout_drain(), wait allowed */
   69 #define CS_MIGRBLOCK            0x0002 /* Block migration, return value
   70                                           indicates that the callout was
   71                                           executing */
   72 
   73 #ifdef _KERNEL
   74 /* 
   75  * Note the flags field is actually *two* fields. The c_flags
   76  * field is the one that caller operations that may, or may not have
   77  * a lock touches i.e. callout_deactivate(). The other, the c_iflags,
   78  * is the internal flags that *must* be kept correct on which the
   79  * callout system depend on e.g. callout_pending().
   80  * The c_iflag is used internally by the callout system to determine which
   81  * list the callout is on and track internal state. Callers *should not* 
   82  * use the c_flags field directly but should use the macros provided.
   83  *  
   84  * The c_iflags field holds internal flags that are protected by internal
   85  * locks of the callout subsystem.  The c_flags field holds external flags.
   86  * The caller must hold its own lock while manipulating or reading external
   87  * flags via callout_active(), callout_deactivate(), callout_reset*(), or
   88  * callout_stop() to avoid races.
   89  */
   90 #define callout_active(c)       ((c)->c_flags & CALLOUT_ACTIVE)
   91 #define callout_deactivate(c)   ((c)->c_flags &= ~CALLOUT_ACTIVE)
   92 #define callout_drain(c)        _callout_stop_safe(c, CS_DRAIN)
   93 void    callout_init(struct callout *, int);
   94 void    _callout_init_lock(struct callout *, struct lock_object *, int);
   95 #define callout_init_mtx(c, mtx, flags)                                 \
   96         _callout_init_lock((c), ((mtx) != NULL) ? &(mtx)->lock_object : \
   97             NULL, (flags))
   98 #define callout_init_rm(c, rm, flags)                                   \
   99         _callout_init_lock((c), ((rm) != NULL) ? &(rm)->lock_object :   \
  100             NULL, (flags))
  101 #define callout_init_rw(c, rw, flags)                                   \
  102         _callout_init_lock((c), ((rw) != NULL) ? &(rw)->lock_object :   \
  103            NULL, (flags))
  104 #define callout_pending(c)      ((c)->c_iflags & CALLOUT_PENDING)
  105 int     callout_reset_sbt_on(struct callout *, sbintime_t, sbintime_t,
  106             void (*)(void *), void *, int, int);
  107 #define callout_reset_sbt(c, sbt, pr, fn, arg, flags)                   \
  108     callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), -1, (flags))
  109 #define callout_reset_sbt_curcpu(c, sbt, pr, fn, arg, flags)            \
  110     callout_reset_sbt_on((c), (sbt), (pr), (fn), (arg), PCPU_GET(cpuid),\
  111         (flags))
  112 #define callout_reset_on(c, to_ticks, fn, arg, cpu)                     \
  113     callout_reset_sbt_on((c), tick_sbt * (to_ticks), 0, (fn), (arg),    \
  114         (cpu), C_HARDCLOCK)
  115 #define callout_reset(c, on_tick, fn, arg)                              \
  116     callout_reset_on((c), (on_tick), (fn), (arg), -1)
  117 #define callout_reset_curcpu(c, on_tick, fn, arg)                       \
  118     callout_reset_on((c), (on_tick), (fn), (arg), PCPU_GET(cpuid))
  119 #define callout_schedule_sbt_on(c, sbt, pr, cpu, flags)                 \
  120     callout_reset_sbt_on((c), (sbt), (pr), (c)->c_func, (c)->c_arg,     \
  121         (cpu), (flags))
  122 #define callout_schedule_sbt(c, sbt, pr, flags)                         \
  123     callout_schedule_sbt_on((c), (sbt), (pr), -1, (flags))
  124 #define callout_schedule_sbt_curcpu(c, sbt, pr, flags)                  \
  125     callout_schedule_sbt_on((c), (sbt), (pr), PCPU_GET(cpuid), (flags))
  126 int     callout_schedule(struct callout *, int);
  127 int     callout_schedule_on(struct callout *, int, int);
  128 #define callout_schedule_curcpu(c, on_tick)                             \
  129     callout_schedule_on((c), (on_tick), PCPU_GET(cpuid))
  130 #define callout_stop(c)         _callout_stop_safe(c, 0)
  131 int     _callout_stop_safe(struct callout *, int);
  132 void    callout_process(sbintime_t now);
  133 
  134 void callout_when(sbintime_t sbt, sbintime_t precision, int flags,
  135     sbintime_t *sbt_res, sbintime_t *prec_res);
  136 #endif
  137 
  138 #endif /* _SYS_CALLOUT_H_ */

Cache object: 68dee9ccfcceebf9ed1a51cc026565bf


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.