1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2014 Jeffrey Roberson <jeff@freebsd.org> 5 * Copyright (c) 2016 Matthew Macy <mmacy@mattmacy.io> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD$ 30 */ 31 32 #ifndef _SYS_GTASKQUEUE_H_ 33 #define _SYS_GTASKQUEUE_H_ 34 #include <sys/taskqueue.h> 35 36 #ifndef _KERNEL 37 #error "no user-serviceable parts inside" 38 #endif 39 40 struct gtaskqueue; 41 typedef void (*gtaskqueue_enqueue_fn)(void *context); 42 43 /* 44 * Taskqueue groups. Manages dynamic thread groups and irq binding for 45 * device and other tasks. 46 */ 47 48 void gtaskqueue_block(struct gtaskqueue *queue); 49 void gtaskqueue_unblock(struct gtaskqueue *queue); 50 51 int gtaskqueue_cancel(struct gtaskqueue *queue, struct gtask *gtask); 52 void gtaskqueue_drain(struct gtaskqueue *queue, struct gtask *task); 53 void gtaskqueue_drain_all(struct gtaskqueue *queue); 54 55 int grouptaskqueue_enqueue(struct gtaskqueue *queue, struct gtask *task); 56 void taskqgroup_attach(struct taskqgroup *qgroup, struct grouptask *grptask, 57 void *uniq, int irq, const char *name); 58 int taskqgroup_attach_cpu(struct taskqgroup *qgroup, struct grouptask *grptask, 59 void *uniq, int cpu, int irq, char *name); 60 void taskqgroup_detach(struct taskqgroup *qgroup, struct grouptask *gtask); 61 struct taskqgroup *taskqgroup_create(char *name); 62 void taskqgroup_destroy(struct taskqgroup *qgroup); 63 int taskqgroup_adjust(struct taskqgroup *qgroup, int cnt, int stride); 64 void taskqgroup_config_gtask_init(void *ctx, struct grouptask *gtask, gtask_fn_t *fn, 65 const char *name); 66 void taskqgroup_config_gtask_deinit(struct grouptask *gtask); 67 68 #define TASK_ENQUEUED 0x1 69 #define TASK_SKIP_WAKEUP 0x2 70 71 72 #define GTASK_INIT(task, flags, priority, func, context) do { \ 73 (task)->ta_flags = flags; \ 74 (task)->ta_priority = (priority); \ 75 (task)->ta_func = (func); \ 76 (task)->ta_context = (context); \ 77 } while (0) 78 79 #define GROUPTASK_INIT(gtask, priority, func, context) \ 80 GTASK_INIT(&(gtask)->gt_task, TASK_SKIP_WAKEUP, priority, func, context) 81 82 #define GROUPTASK_ENQUEUE(gtask) \ 83 grouptaskqueue_enqueue((gtask)->gt_taskqueue, &(gtask)->gt_task) 84 85 #define TASKQGROUP_DECLARE(name) \ 86 extern struct taskqgroup *qgroup_##name 87 88 #define TASKQGROUP_DEFINE(name, cnt, stride) \ 89 \ 90 struct taskqgroup *qgroup_##name; \ 91 \ 92 static void \ 93 taskqgroup_define_##name(void *arg) \ 94 { \ 95 qgroup_##name = taskqgroup_create(#name); \ 96 } \ 97 \ 98 SYSINIT(taskqgroup_##name, SI_SUB_TASKQ, SI_ORDER_FIRST, \ 99 taskqgroup_define_##name, NULL); \ 100 \ 101 static void \ 102 taskqgroup_adjust_##name(void *arg) \ 103 { \ 104 taskqgroup_adjust(qgroup_##name, (cnt), (stride)); \ 105 } \ 106 \ 107 SYSINIT(taskqgroup_adj_##name, SI_SUB_SMP, SI_ORDER_ANY, \ 108 taskqgroup_adjust_##name, NULL) 109 110 TASKQGROUP_DECLARE(net); 111 TASKQGROUP_DECLARE(softirq); 112 113 #endif /* !_SYS_GTASKQUEUE_H_ */ 114