sys/sys/gtaskqueue.h

   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
  35 #ifndef _KERNEL
  36 #error "no user-serviceable parts inside"
  37 #endif
  38
  39 #include <sys/_task.h>
  40 #include <sys/bus.h>
  41 #include <sys/taskqueue.h>
  42 #include <sys/types.h>
  43
  44 struct gtaskqueue;
  45
  46 /*
  47  * Taskqueue groups.  Manages dynamic thread groups and irq binding for
  48  * device and other tasks.
  49  */
  50
  51 struct grouptask {
  52         struct gtask            gt_task;
  53         void                    *gt_taskqueue;
  54         LIST_ENTRY(grouptask)   gt_list;
  55         void                    *gt_uniq;
  56 #define GROUPTASK_NAMELEN       32
  57         char                    gt_name[GROUPTASK_NAMELEN];
  58         device_t                gt_dev;
  59         struct resource         *gt_irq;
  60         int                     gt_cpu;
  61 };
  62
  63 void    gtaskqueue_block(struct gtaskqueue *queue);
  64 void    gtaskqueue_unblock(struct gtaskqueue *queue);
  65
  66 int     gtaskqueue_cancel(struct gtaskqueue *queue, struct gtask *gtask);
  67 void    gtaskqueue_drain(struct gtaskqueue *queue, struct gtask *task);
  68 void    gtaskqueue_drain_all(struct gtaskqueue *queue);
  69
  70 void    grouptask_block(struct grouptask *grouptask);
  71 void    grouptask_unblock(struct grouptask *grouptask);
  72 int     grouptaskqueue_enqueue(struct gtaskqueue *queue, struct gtask *task);
  73
  74 void    taskqgroup_attach(struct taskqgroup *qgroup, struct grouptask *grptask,
  75             void *uniq, device_t dev, struct resource *irq, const char *name);
  76 int     taskqgroup_attach_cpu(struct taskqgroup *qgroup,
  77             struct grouptask *grptask, void *uniq, int cpu, device_t dev,
  78             struct resource *irq, const char *name);
  79 void    taskqgroup_detach(struct taskqgroup *qgroup, struct grouptask *gtask);
  80 struct taskqgroup *taskqgroup_create(const char *name, int cnt, int stride);
  81 void    taskqgroup_destroy(struct taskqgroup *qgroup);
  82 void    taskqgroup_bind(struct taskqgroup *qgroup);
  83 void    taskqgroup_drain_all(struct taskqgroup *qgroup);
  84
  85 #define GTASK_INIT(gtask, flags, priority, func, context) do {  \
  86         (gtask)->ta_flags = flags;                              \
  87         (gtask)->ta_priority = (priority);                      \
  88         (gtask)->ta_func = (func);                              \
  89         (gtask)->ta_context = (context);                        \
  90 } while (0)
  91
  92 #define GROUPTASK_INIT(gtask, priority, func, context)  \
  93         GTASK_INIT(&(gtask)->gt_task, 0, priority, func, context)
  94
  95 #define GROUPTASK_ENQUEUE(gtask)                        \
  96         grouptaskqueue_enqueue((gtask)->gt_taskqueue, &(gtask)->gt_task)
  97
  98 #define TASKQGROUP_DECLARE(name)                        \
  99 extern struct taskqgroup *qgroup_##name
 100
 101 #define TASKQGROUP_DEFINE(name, cnt, stride)                            \
 102                                                                         \
 103 struct taskqgroup *qgroup_##name;                                       \
 104                                                                         \
 105 static void                                                             \
 106 taskqgroup_define_##name(void *arg)                                     \
 107 {                                                                       \
 108         qgroup_##name = taskqgroup_create(#name, (cnt), (stride));      \
 109 }                                                                       \
 110 SYSINIT(taskqgroup_##name, SI_SUB_TASKQ, SI_ORDER_FIRST,                \
 111     taskqgroup_define_##name, NULL);                                    \
 112                                                                         \
 113 static void                                                             \
 114 taskqgroup_bind_##name(void *arg)                                       \
 115 {                                                                       \
 116         taskqgroup_bind(qgroup_##name);                                 \
 117 }                                                                       \
 118 SYSINIT(taskqgroup_bind_##name, SI_SUB_SMP, SI_ORDER_ANY,               \
 119     taskqgroup_bind_##name, NULL)
 120
 121 TASKQGROUP_DECLARE(softirq);
 122
 123 #endif /* !_SYS_GTASKQUEUE_H_ */