1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 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 28 #ifndef _SYS_EPOCH_H_ 29 #define _SYS_EPOCH_H_ 30 31 struct epoch_context { 32 void *data[2]; 33 } __aligned(sizeof(void *)); 34 35 typedef struct epoch_context *epoch_context_t; 36 typedef void epoch_callback_t(epoch_context_t); 37 38 #ifdef _KERNEL 39 #include <sys/lock.h> 40 #include <sys/pcpu.h> 41 #include <ck_epoch.h> 42 43 struct epoch; 44 typedef struct epoch *epoch_t; 45 46 #define EPOCH_PREEMPT 0x1 47 #define EPOCH_LOCKED 0x2 48 49 extern epoch_t global_epoch; 50 extern epoch_t global_epoch_preempt; 51 52 struct epoch_tracker { 53 TAILQ_ENTRY(epoch_tracker) et_link; 54 struct thread *et_td; 55 ck_epoch_section_t et_section; 56 uint8_t et_old_priority; 57 #ifdef EPOCH_TRACE 58 struct epoch *et_epoch; 59 SLIST_ENTRY(epoch_tracker) et_tlink; 60 const char *et_file; 61 int et_line; 62 #endif 63 } __aligned(sizeof(void *)); 64 typedef struct epoch_tracker *epoch_tracker_t; 65 66 epoch_t epoch_alloc(const char *name, int flags); 67 void epoch_free(epoch_t epoch); 68 void epoch_wait(epoch_t epoch); 69 void epoch_wait_preempt(epoch_t epoch); 70 void epoch_drain_callbacks(epoch_t epoch); 71 void epoch_call(epoch_t epoch, epoch_callback_t cb, epoch_context_t ctx); 72 int in_epoch(epoch_t epoch); 73 int in_epoch_verbose(epoch_t epoch, int dump_onfail); 74 DPCPU_DECLARE(int, epoch_cb_count); 75 DPCPU_DECLARE(struct grouptask, epoch_cb_task); 76 77 #ifdef EPOCH_TRACE 78 #define EPOCH_FILE_LINE , const char *file, int line 79 #else 80 #define EPOCH_FILE_LINE 81 #endif 82 83 void _epoch_enter_preempt(epoch_t epoch, epoch_tracker_t et EPOCH_FILE_LINE); 84 void _epoch_exit_preempt(epoch_t epoch, epoch_tracker_t et EPOCH_FILE_LINE); 85 #ifdef EPOCH_TRACE 86 void epoch_trace_list(struct thread *); 87 #define epoch_enter_preempt(epoch, et) _epoch_enter_preempt(epoch, et, __FILE__, __LINE__) 88 #define epoch_exit_preempt(epoch, et) _epoch_exit_preempt(epoch, et, __FILE__, __LINE__) 89 #else 90 #define epoch_enter_preempt(epoch, et) _epoch_enter_preempt(epoch, et) 91 #define epoch_exit_preempt(epoch, et) _epoch_exit_preempt(epoch, et) 92 #endif 93 void epoch_enter(epoch_t epoch); 94 void epoch_exit(epoch_t epoch); 95 96 /* 97 * Globally recognized epochs in the FreeBSD kernel. 98 */ 99 /* Network preemptible epoch, declared in sys/net/if.c. */ 100 extern epoch_t net_epoch_preempt; 101 #define NET_EPOCH_ENTER(et) epoch_enter_preempt(net_epoch_preempt, &(et)) 102 #define NET_EPOCH_EXIT(et) epoch_exit_preempt(net_epoch_preempt, &(et)) 103 #define NET_EPOCH_WAIT() epoch_wait_preempt(net_epoch_preempt) 104 #define NET_EPOCH_CALL(f, c) epoch_call(net_epoch_preempt, (f), (c)) 105 #define NET_EPOCH_DRAIN_CALLBACKS() epoch_drain_callbacks(net_epoch_preempt) 106 #define NET_EPOCH_ASSERT() MPASS(in_epoch(net_epoch_preempt)) 107 #define NET_TASK_INIT(t, p, f, c) TASK_INIT_FLAGS(t, p, f, c, TASK_NETWORK) 108 #define NET_GROUPTASK_INIT(gtask, prio, func, ctx) \ 109 GTASK_INIT(&(gtask)->gt_task, TASK_NETWORK, (prio), (func), (ctx)) 110 111 #endif /* _KERNEL */ 112 #endif /* _SYS_EPOCH_H_ */ 113