sys/sys/taskqueue.h

   1 /*-
   2  * Copyright (c) 2000 Doug Rabson
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _SYS_TASKQUEUE_H_
  30 #define _SYS_TASKQUEUE_H_
  31
  32 #ifndef _KERNEL
  33 #error "no user-servicable parts inside"
  34 #endif
  35
  36 #include <sys/queue.h>
  37 #include <sys/_task.h>
  38 #include <sys/_callout.h>
  39 #include <sys/_cpuset.h>
  40
  41 struct taskqueue;
  42 struct taskqgroup;
  43 struct thread;
  44
  45 struct timeout_task {
  46         struct taskqueue *q;
  47         struct task t;
  48         struct callout c;
  49         int    f;
  50 };
  51
  52 enum taskqueue_callback_type {
  53         TASKQUEUE_CALLBACK_TYPE_INIT,
  54         TASKQUEUE_CALLBACK_TYPE_SHUTDOWN,
  55 };
  56 #define TASKQUEUE_CALLBACK_TYPE_MIN     TASKQUEUE_CALLBACK_TYPE_INIT
  57 #define TASKQUEUE_CALLBACK_TYPE_MAX     TASKQUEUE_CALLBACK_TYPE_SHUTDOWN
  58 #define TASKQUEUE_NUM_CALLBACKS         TASKQUEUE_CALLBACK_TYPE_MAX + 1
  59 #define TASKQUEUE_NAMELEN               32
  60
  61 typedef void (*taskqueue_callback_fn)(void *context);
  62
  63 /*
  64  * A notification callback function which is called from
  65  * taskqueue_enqueue().  The context argument is given in the call to
  66  * taskqueue_create().  This function would normally be used to allow the
  67  * queue to arrange to run itself later (e.g., by scheduling a software
  68  * interrupt or waking a kernel thread).
  69  */
  70 typedef void (*taskqueue_enqueue_fn)(void *context);
  71
  72 struct taskqueue *taskqueue_create(const char *name, int mflags,
  73                                     taskqueue_enqueue_fn enqueue,
  74                                     void *context);
  75 int     taskqueue_start_threads(struct taskqueue **tqp, int count, int pri,
  76                                 const char *name, ...) __printflike(4, 5);
  77 int     taskqueue_start_threads_cpuset(struct taskqueue **tqp, int count,
  78             int pri, cpuset_t *mask, const char *name, ...) __printflike(5, 6);
  79 int     taskqueue_enqueue(struct taskqueue *queue, struct task *task);
  80 int     taskqueue_enqueue_timeout(struct taskqueue *queue,
  81             struct timeout_task *timeout_task, int ticks);
  82 int     taskqueue_enqueue_timeout_sbt(struct taskqueue *queue,
  83             struct timeout_task *timeout_task, sbintime_t sbt, sbintime_t pr,
  84             int flags);
  85 int     taskqueue_poll_is_busy(struct taskqueue *queue, struct task *task);
  86 int     taskqueue_cancel(struct taskqueue *queue, struct task *task,
  87             u_int *pendp);
  88 int     taskqueue_cancel_timeout(struct taskqueue *queue,
  89             struct timeout_task *timeout_task, u_int *pendp);
  90 void    taskqueue_drain(struct taskqueue *queue, struct task *task);
  91 void    taskqueue_drain_timeout(struct taskqueue *queue,
  92             struct timeout_task *timeout_task);
  93 void    taskqueue_drain_all(struct taskqueue *queue);
  94 void    taskqueue_quiesce(struct taskqueue *queue);
  95 void    taskqueue_free(struct taskqueue *queue);
  96 void    taskqueue_run(struct taskqueue *queue);
  97 void    taskqueue_block(struct taskqueue *queue);
  98 void    taskqueue_unblock(struct taskqueue *queue);
  99 int     taskqueue_member(struct taskqueue *queue, struct thread *td);
 100 void    taskqueue_set_callback(struct taskqueue *queue,
 101             enum taskqueue_callback_type cb_type,
 102             taskqueue_callback_fn callback, void *context);
 103
 104 #define TASK_INITIALIZER(priority, func, context)       \
 105         { .ta_pending = 0,                              \
 106           .ta_priority = (priority),                    \
 107           .ta_func = (func),                            \
 108           .ta_context = (context) }
 109
 110 /*
 111  * Functions for dedicated thread taskqueues
 112  */
 113 void    taskqueue_thread_loop(void *arg);
 114 void    taskqueue_thread_enqueue(void *context);
 115
 116 /*
 117  * Initialise a task structure.
 118  */
 119 #define TASK_INIT(task, priority, func, context) do {   \
 120         (task)->ta_pending = 0;                         \
 121         (task)->ta_priority = (priority);               \
 122         (task)->ta_func = (func);                       \
 123         (task)->ta_context = (context);                 \
 124 } while (0)
 125
 126 void _timeout_task_init(struct taskqueue *queue,
 127             struct timeout_task *timeout_task, int priority, task_fn_t func,
 128             void *context);
 129 #define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) \
 130         _timeout_task_init(queue, timeout_task, priority, func, context);
 131
 132 /*
 133  * Declare a reference to a taskqueue.
 134  */
 135 #define TASKQUEUE_DECLARE(name)                 \
 136 extern struct taskqueue *taskqueue_##name
 137
 138 /*
 139  * Define and initialise a global taskqueue that uses sleep mutexes.
 140  */
 141 #define TASKQUEUE_DEFINE(name, enqueue, context, init)                  \
 142                                                                         \
 143 struct taskqueue *taskqueue_##name;                                     \
 144                                                                         \
 145 static void                                                             \
 146 taskqueue_define_##name(void *arg)                                      \
 147 {                                                                       \
 148         taskqueue_##name =                                              \
 149             taskqueue_create(#name, M_WAITOK, (enqueue), (context));    \
 150         init;                                                           \
 151 }                                                                       \
 152                                                                         \
 153 SYSINIT(taskqueue_##name, SI_SUB_TASKQ, SI_ORDER_SECOND,                \
 154         taskqueue_define_##name, NULL);                                 \
 155                                                                         \
 156 struct __hack
 157 #define TASKQUEUE_DEFINE_THREAD(name)                                   \
 158 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name,     \
 159         taskqueue_start_threads(&taskqueue_##name, 1, PWAIT,            \
 160         "%s taskq", #name))
 161
 162 /*
 163  * Define and initialise a global taskqueue that uses spin mutexes.
 164  */
 165 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init)             \
 166                                                                         \
 167 struct taskqueue *taskqueue_##name;                                     \
 168                                                                         \
 169 static void                                                             \
 170 taskqueue_define_##name(void *arg)                                      \
 171 {                                                                       \
 172         taskqueue_##name =                                              \
 173             taskqueue_create_fast(#name, M_WAITOK, (enqueue),           \
 174             (context));                                                 \
 175         init;                                                           \
 176 }                                                                       \
 177                                                                         \
 178 SYSINIT(taskqueue_##name, SI_SUB_TASKQ, SI_ORDER_SECOND,                \
 179         taskqueue_define_##name, NULL);                                 \
 180                                                                         \
 181 struct __hack
 182 #define TASKQUEUE_FAST_DEFINE_THREAD(name)                              \
 183 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue,                   \
 184         &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name    \
 185         1, PWAIT, "%s taskq", #name))
 186
 187 /*
 188  * These queues are serviced by software interrupt handlers.  To enqueue
 189  * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
 190  * taskqueue_enqueue(taskqueue_swi_giant, &task).
 191  */
 192 TASKQUEUE_DECLARE(swi_giant);
 193 TASKQUEUE_DECLARE(swi);
 194
 195 /*
 196  * This queue is serviced by a kernel thread.  To enqueue a task, call
 197  * taskqueue_enqueue(taskqueue_thread, &task).
 198  */
 199 TASKQUEUE_DECLARE(thread);
 200
 201 /*
 202  * Queue for swi handlers dispatched from fast interrupt handlers.
 203  * These are necessarily different from the above because the queue
 204  * must be locked with spinlocks since sleep mutex's cannot be used
 205  * from a fast interrupt handler context.
 206  */
 207 TASKQUEUE_DECLARE(fast);
 208 struct taskqueue *taskqueue_create_fast(const char *name, int mflags,
 209                                     taskqueue_enqueue_fn enqueue,
 210                                     void *context);
 211
 212 #endif /* !_SYS_TASKQUEUE_H_ */