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 #include <sys/lock.h>
  33 #include <sys/proc.h>
  34
  35 struct epoch;
  36 typedef struct epoch *epoch_t;
  37
  38 extern epoch_t global_epoch;
  39
  40 struct epoch_context {
  41         void *data[2];
  42 } __aligned(sizeof(void *));
  43
  44 typedef struct epoch_context *epoch_context_t;
  45
  46 epoch_t epoch_alloc(void);
  47 void epoch_free(epoch_t epoch);
  48 void epoch_enter_internal(epoch_t epoch, struct thread *td);
  49 void epoch_exit_internal(epoch_t epoch, struct thread *td);
  50 void epoch_wait(epoch_t epoch);
  51 void epoch_call(epoch_t epoch, epoch_context_t ctx, void (*callback) (epoch_context_t));
  52 int in_epoch(void);
  53
  54 static __inline void
  55 epoch_enter(epoch_t epoch)
  56 {
  57         struct thread *td;
  58         int nesting;
  59
  60         td = curthread;
  61         nesting = td->td_epochnest++;
  62 #ifndef INVARIANTS
  63         if (nesting == 0)
  64 #endif
  65                 epoch_enter_internal(epoch, td);
  66 }
  67
  68 static __inline void
  69 epoch_exit(epoch_t epoch)
  70 {
  71         struct thread *td;
  72
  73         td = curthread;
  74         MPASS(td->td_epochnest);
  75         if (td->td_epochnest-- == 1)
  76                 epoch_exit_internal(epoch, td);
  77 }
  78
  79 #endif