sys/sys/epoch.h

   1 /*-
   2  * Copyright (c) 2018, Matthew Macy <mmacy@freebsd.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *  1. Redistributions of source code must retain the above copyright notice,
   8  *     this list of conditions and the following disclaimer.
   9  *
  10  *  2. Neither the name of Matthew Macy nor the names of its
  11  *     contributors may be used to endorse or promote products derived from
  12  *     this software without specific prior written permission.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24  * POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _SYS_EPOCH_H_
  30 #define _SYS_EPOCH_H_
  31
  32 struct epoch;
  33 typedef struct epoch *epoch_t;
  34
  35 struct epoch_context {
  36         void *data[2];
  37 } __aligned(sizeof(void *));
  38
  39 typedef struct epoch_context *epoch_context_t;
  40
  41 epoch_t epoch_alloc(void);
  42 void epoch_free(epoch_t epoch);
  43 void epoch_enter(epoch_t epoch);
  44 void epoch_exit(epoch_t epoch);
  45 void epoch_enter_nopreempt(epoch_t epoch);
  46 void epoch_exit_nopreempt(epoch_t epoch);
  47 void epoch_wait(epoch_t epoch);
  48 void epoch_call(epoch_t epoch, epoch_context_t ctx, void (*callback) (epoch_context_t));
  49 int in_epoch(void);
  50
  51 #endif