sys/sys/epoch.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2018, Matthew Macy <mmacy@freebsd.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _SYS_EPOCH_H_
  31 #define _SYS_EPOCH_H_
  32 #ifdef _KERNEL
  33 #include <sys/lock.h>
  34 #include <sys/pcpu.h>
  35 #endif
  36
  37 struct epoch;
  38 typedef struct epoch *epoch_t;
  39
  40 #define EPOCH_PREEMPT 0x1
  41 #define EPOCH_LOCKED 0x2
  42
  43 extern epoch_t global_epoch;
  44 extern epoch_t global_epoch_preempt;
  45
  46 struct epoch_context {
  47         void   *data[2];
  48 } __aligned(sizeof(void *));
  49
  50 typedef struct epoch_context *epoch_context_t;
  51
  52
  53 struct epoch_tracker {
  54         void *datap[3];
  55 #ifdef EPOCH_TRACKER_DEBUG
  56         int datai[5];
  57 #else
  58         int datai[1];
  59 #endif
  60 }  __aligned(sizeof(void *));
  61
  62 typedef struct epoch_tracker *epoch_tracker_t;
  63
  64 epoch_t epoch_alloc(int flags);
  65 void    epoch_free(epoch_t epoch);
  66 void    epoch_wait(epoch_t epoch);
  67 void    epoch_wait_preempt(epoch_t epoch);
  68 void    epoch_call(epoch_t epoch, epoch_context_t ctx, void (*callback) (epoch_context_t));
  69 int     in_epoch(epoch_t epoch);
  70 int in_epoch_verbose(epoch_t epoch, int dump_onfail);
  71 #ifdef _KERNEL
  72 DPCPU_DECLARE(int, epoch_cb_count);
  73 DPCPU_DECLARE(struct grouptask, epoch_cb_task);
  74 #define EPOCH_MAGIC0 0xFADECAFEF00DD00D
  75 #define EPOCH_MAGIC1 0xBADDBABEDEEDFEED
  76
  77 void epoch_enter_preempt_KBI(epoch_t epoch, epoch_tracker_t et);
  78 void epoch_exit_preempt_KBI(epoch_t epoch, epoch_tracker_t et);
  79 void epoch_enter_KBI(epoch_t epoch);
  80 void epoch_exit_KBI(epoch_t epoch);
  81
  82
  83 #if defined(KLD_MODULE) && !defined(KLD_TIED)
  84 #define epoch_enter_preempt(e, t)       epoch_enter_preempt_KBI((e), (t))
  85 #define epoch_exit_preempt(e, t)        epoch_exit_preempt_KBI((e), (t))
  86 #define epoch_enter(e)  epoch_enter_KBI((e))
  87 #define epoch_exit(e)   epoch_exit_KBI((e))
  88 #else
  89 #include <sys/epoch_private.h>
  90 #endif /* KLD_MODULE */
  91
  92 #endif /* _KERNEL */
  93 #endif