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/proc.h>
  35 #endif
  36
  37 struct thread;
  38 struct epoch;
  39 typedef struct epoch *epoch_t;
  40
  41 #define EPOCH_PREEMPT 0x1
  42 #define EPOCH_LOCKED 0x2
  43
  44 extern epoch_t global_epoch;
  45 extern epoch_t global_epoch_preempt;
  46
  47 struct epoch_context {
  48         void   *data[2];
  49 }       __aligned(sizeof(void *));
  50
  51 typedef struct epoch_context *epoch_context_t;
  52
  53 epoch_t epoch_alloc(int flags);
  54 void    epoch_free(epoch_t epoch);
  55 void    epoch_enter(epoch_t epoch);
  56 void    epoch_enter_preempt_internal(epoch_t epoch, struct thread *td);
  57 void    epoch_exit(epoch_t epoch);
  58 void    epoch_exit_preempt_internal(epoch_t epoch, struct thread *td);
  59 void    epoch_wait(epoch_t epoch);
  60 void    epoch_wait_preempt(epoch_t epoch);
  61 void    epoch_call(epoch_t epoch, epoch_context_t ctx, void (*callback) (epoch_context_t));
  62 int     in_epoch(void);
  63
  64 #ifdef _KERNEL
  65 DPCPU_DECLARE(int, epoch_cb_count);
  66 DPCPU_DECLARE(struct grouptask, epoch_cb_task);
  67
  68 static __inline void
  69 epoch_enter_preempt(epoch_t epoch)
  70 {
  71         struct thread *td;
  72         int nesting __unused;
  73
  74         td = curthread;
  75         nesting = td->td_epochnest++;
  76 #ifndef INVARIANTS
  77         if (nesting == 0)
  78 #endif
  79                 epoch_enter_preempt_internal(epoch, td);
  80 }
  81
  82 static __inline void
  83 epoch_exit_preempt(epoch_t epoch)
  84 {
  85         struct thread *td;
  86
  87         td = curthread;
  88         MPASS(td->td_epochnest);
  89         if (td->td_epochnest-- == 1)
  90                 epoch_exit_preempt_internal(epoch, td);
  91 }
  92 #endif                                  /* _KERNEL */
  93 #endif