2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2018, Matthew Macy <mmacy@freebsd.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
33 struct epoch_context {
35 } __aligned(sizeof(void *));
37 typedef struct epoch_context *epoch_context_t;
38 typedef void epoch_callback_t(epoch_context_t);
46 typedef struct epoch *epoch_t;
48 #define EPOCH_PREEMPT 0x1
49 #define EPOCH_LOCKED 0x2
51 extern epoch_t global_epoch;
52 extern epoch_t global_epoch_preempt;
54 struct epoch_tracker {
55 TAILQ_ENTRY(epoch_tracker) et_link;
57 ck_epoch_section_t et_section;
58 uint8_t et_old_priority;
60 struct epoch *et_epoch;
61 SLIST_ENTRY(epoch_tracker) et_tlink;
65 } __aligned(sizeof(void *));
66 typedef struct epoch_tracker *epoch_tracker_t;
68 epoch_t epoch_alloc(const char *name, 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_callback_t cb, epoch_context_t ctx);
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);
80 #define EPOCH_FILE_LINE , const char *file, int line
82 #define EPOCH_FILE_LINE
85 void _epoch_enter_preempt(epoch_t epoch, epoch_tracker_t et EPOCH_FILE_LINE);
86 void _epoch_exit_preempt(epoch_t epoch, epoch_tracker_t et EPOCH_FILE_LINE);
88 void epoch_trace_list(struct thread *);
89 #define epoch_enter_preempt(epoch, et) _epoch_enter_preempt(epoch, et, __FILE__, __LINE__)
90 #define epoch_exit_preempt(epoch, et) _epoch_exit_preempt(epoch, et, __FILE__, __LINE__)
92 #define epoch_enter_preempt(epoch, et) _epoch_enter_preempt(epoch, et)
93 #define epoch_exit_preempt(epoch, et) _epoch_exit_preempt(epoch, et)
95 void epoch_enter(epoch_t epoch);
96 void epoch_exit(epoch_t epoch);
99 * Globally recognized epochs in the FreeBSD kernel.
101 /* Network preemptible epoch, declared in sys/net/if.c. */
102 extern epoch_t net_epoch_preempt;
103 #define NET_EPOCH_ENTER(et) epoch_enter_preempt(net_epoch_preempt, &(et))
104 #define NET_EPOCH_EXIT(et) epoch_exit_preempt(net_epoch_preempt, &(et))
105 #define NET_EPOCH_WAIT() epoch_wait_preempt(net_epoch_preempt)
106 #define NET_EPOCH_CALL(f, c) epoch_call(net_epoch_preempt, (f), (c))
107 #define NET_EPOCH_DRAIN_CALLBACKS() epoch_drain_callbacks(net_epoch_preempt)
108 #define NET_EPOCH_ASSERT() MPASS(in_epoch(net_epoch_preempt))
109 #define NET_TASK_INIT(t, p, f, c) TASK_INIT_FLAGS(t, p, f, c, TASK_NETWORK)
110 #define NET_GROUPTASK_INIT(gtask, prio, func, ctx) \
111 GTASK_INIT(&(gtask)->gt_task, TASK_NETWORK, (prio), (func), (ctx))
114 #endif /* _SYS_EPOCH_H_ */