FreeBSD/Linux Kernel Cross Reference
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
33 struct epoch_context {
34 void *data[2];
35 } __aligned(sizeof(void *));
36
37 typedef struct epoch_context *epoch_context_t;
38
39 #ifdef _KERNEL
40 #include <sys/lock.h>
41 #include <sys/pcpu.h>
42 #include <ck_epoch.h>
43
44 struct epoch;
45 typedef struct epoch *epoch_t;
46
47 #define EPOCH_PREEMPT 0x1
48 #define EPOCH_LOCKED 0x2
49
50 extern epoch_t global_epoch;
51 extern epoch_t global_epoch_preempt;
52
53 struct epoch_tracker {
54 #ifdef EPOCH_TRACKER_DEBUG
55 #define EPOCH_MAGIC0 0xFADECAFEF00DD00D
56 #define EPOCH_MAGIC1 0xBADDBABEDEEDFEED
57 uint64_t et_magic_pre;
58 #endif
59 TAILQ_ENTRY(epoch_tracker) et_link;
60 struct thread *et_td;
61 ck_epoch_section_t et_section;
62 #ifdef EPOCH_TRACKER_DEBUG
63 uint64_t et_magic_post;
64 #endif
65 } __aligned(sizeof(void *));
66 typedef struct epoch_tracker *epoch_tracker_t;
67
68 epoch_t epoch_alloc(int flags);
69 void epoch_free(epoch_t epoch);
70 void epoch_wait(epoch_t epoch);
71 void epoch_wait_preempt(epoch_t epoch);
72 void epoch_drain_callbacks(epoch_t epoch);
73 void epoch_call(epoch_t epoch, epoch_context_t ctx, void (*callback) (epoch_context_t));
74 int in_epoch(epoch_t epoch);
75 int in_epoch_verbose(epoch_t epoch, int dump_onfail);
76 DPCPU_DECLARE(int, epoch_cb_count);
77 DPCPU_DECLARE(struct grouptask, epoch_cb_task);
78 #define EPOCH_MAGIC0 0xFADECAFEF00DD00D
79 #define EPOCH_MAGIC1 0xBADDBABEDEEDFEED
80
81 void epoch_enter_preempt(epoch_t epoch, epoch_tracker_t et);
82 void epoch_exit_preempt(epoch_t epoch, epoch_tracker_t et);
83 void epoch_enter(epoch_t epoch);
84 void epoch_exit(epoch_t epoch);
85
86 /* for binary compatibility - do not use */
87 void epoch_enter_preempt_KBI(epoch_t epoch, epoch_tracker_t et);
88 void epoch_exit_preempt_KBI(epoch_t epoch, epoch_tracker_t et);
89 void epoch_enter_KBI(epoch_t epoch);
90 void epoch_exit_KBI(epoch_t epoch);
91
92 #endif /* _KERNEL */
93 #endif /* _SYS_EPOCH_H_ */
Cache object: aff94b249230ef46516bd7e28784edcb
|