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  * 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: releng/11.0/sys/sys/taskqueue.h 304716 2016-08-24 01:56:30Z shurd $
   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_cancel(struct taskqueue *queue, struct task *task,
   83             u_int *pendp);
   84 int     taskqueue_cancel_timeout(struct taskqueue *queue,
   85             struct timeout_task *timeout_task, u_int *pendp);
   86 void    taskqueue_drain(struct taskqueue *queue, struct task *task);
   87 void    taskqueue_drain_timeout(struct taskqueue *queue,
   88             struct timeout_task *timeout_task);
   89 void    taskqueue_drain_all(struct taskqueue *queue);
   90 void    taskqueue_free(struct taskqueue *queue);
   91 void    taskqueue_run(struct taskqueue *queue);
   92 void    taskqueue_block(struct taskqueue *queue);
   93 void    taskqueue_unblock(struct taskqueue *queue);
   94 int     taskqueue_member(struct taskqueue *queue, struct thread *td);
   95 void    taskqueue_set_callback(struct taskqueue *queue,
   96             enum taskqueue_callback_type cb_type,
   97             taskqueue_callback_fn callback, void *context);
   98 
   99 #define TASK_INITIALIZER(priority, func, context)       \
  100         { .ta_pending = 0,                              \
  101           .ta_priority = (priority),                    \
  102           .ta_func = (func),                            \
  103           .ta_context = (context) }
  104 
  105 /*
  106  * Functions for dedicated thread taskqueues
  107  */
  108 void    taskqueue_thread_loop(void *arg);
  109 void    taskqueue_thread_enqueue(void *context);
  110 
  111 /*
  112  * Initialise a task structure.
  113  */
  114 #define TASK_INIT(task, priority, func, context) do {   \
  115         (task)->ta_pending = 0;                         \
  116         (task)->ta_priority = (priority);               \
  117         (task)->ta_func = (func);                       \
  118         (task)->ta_context = (context);                 \
  119 } while (0)
  120 
  121 void _timeout_task_init(struct taskqueue *queue,
  122             struct timeout_task *timeout_task, int priority, task_fn_t func,
  123             void *context);
  124 #define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) \
  125         _timeout_task_init(queue, timeout_task, priority, func, context);
  126 
  127 /*
  128  * Declare a reference to a taskqueue.
  129  */
  130 #define TASKQUEUE_DECLARE(name)                 \
  131 extern struct taskqueue *taskqueue_##name
  132 
  133 /*
  134  * Define and initialise a global taskqueue that uses sleep mutexes.
  135  */
  136 #define TASKQUEUE_DEFINE(name, enqueue, context, init)                  \
  137                                                                         \
  138 struct taskqueue *taskqueue_##name;                                     \
  139                                                                         \
  140 static void                                                             \
  141 taskqueue_define_##name(void *arg)                                      \
  142 {                                                                       \
  143         taskqueue_##name =                                              \
  144             taskqueue_create(#name, M_WAITOK, (enqueue), (context));    \
  145         init;                                                           \
  146 }                                                                       \
  147                                                                         \
  148 SYSINIT(taskqueue_##name, SI_SUB_INIT_IF, SI_ORDER_SECOND,              \
  149         taskqueue_define_##name, NULL);                                 \
  150                                                                         \
  151 struct __hack
  152 #define TASKQUEUE_DEFINE_THREAD(name)                                   \
  153 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name,     \
  154         taskqueue_start_threads(&taskqueue_##name, 1, PWAIT,            \
  155         "%s taskq", #name))
  156 
  157 /*
  158  * Define and initialise a global taskqueue that uses spin mutexes.
  159  */
  160 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init)             \
  161                                                                         \
  162 struct taskqueue *taskqueue_##name;                                     \
  163                                                                         \
  164 static void                                                             \
  165 taskqueue_define_##name(void *arg)                                      \
  166 {                                                                       \
  167         taskqueue_##name =                                              \
  168             taskqueue_create_fast(#name, M_WAITOK, (enqueue),           \
  169             (context));                                                 \
  170         init;                                                           \
  171 }                                                                       \
  172                                                                         \
  173 SYSINIT(taskqueue_##name, SI_SUB_INIT_IF, SI_ORDER_SECOND,              \
  174         taskqueue_define_##name, NULL);                                 \
  175                                                                         \
  176 struct __hack
  177 #define TASKQUEUE_FAST_DEFINE_THREAD(name)                              \
  178 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue,                   \
  179         &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name    \
  180         1, PWAIT, "%s taskq", #name))
  181 
  182 /*
  183  * These queues are serviced by software interrupt handlers.  To enqueue
  184  * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
  185  * taskqueue_enqueue(taskqueue_swi_giant, &task).
  186  */
  187 TASKQUEUE_DECLARE(swi_giant);
  188 TASKQUEUE_DECLARE(swi);
  189 
  190 /*
  191  * This queue is serviced by a kernel thread.  To enqueue a task, call
  192  * taskqueue_enqueue(taskqueue_thread, &task).
  193  */
  194 TASKQUEUE_DECLARE(thread);
  195 
  196 /*
  197  * Queue for swi handlers dispatched from fast interrupt handlers.
  198  * These are necessarily different from the above because the queue
  199  * must be locked with spinlocks since sleep mutex's cannot be used
  200  * from a fast interrupt handler context.
  201  */
  202 TASKQUEUE_DECLARE(fast);
  203 struct taskqueue *taskqueue_create_fast(const char *name, int mflags,
  204                                     taskqueue_enqueue_fn enqueue,
  205                                     void *context);
  206 
  207 #endif /* !_SYS_TASKQUEUE_H_ */

Cache object: 01cdff291bdaa1a256d45f92be9e78cf

[ 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