taskqueue.h

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

FreeBSD/Linux Kernel Cross Reference
sys/sys/taskqueue.h
