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/10.0/sys/sys/taskqueue.h 248649 2013-03-23 15:11:53Z will $
   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 
   40 struct taskqueue;
   41 struct thread;
   42 
   43 struct timeout_task {
   44         struct taskqueue *q;
   45         struct task t;
   46         struct callout c;
   47         int    f;
   48 };
   49 
   50 enum taskqueue_callback_type {
   51         TASKQUEUE_CALLBACK_TYPE_INIT,
   52         TASKQUEUE_CALLBACK_TYPE_SHUTDOWN,
   53 };
   54 #define TASKQUEUE_CALLBACK_TYPE_MIN     TASKQUEUE_CALLBACK_TYPE_INIT
   55 #define TASKQUEUE_CALLBACK_TYPE_MAX     TASKQUEUE_CALLBACK_TYPE_SHUTDOWN
   56 #define TASKQUEUE_NUM_CALLBACKS         TASKQUEUE_CALLBACK_TYPE_MAX + 1
   57 
   58 typedef void (*taskqueue_callback_fn)(void *context);
   59 
   60 /*
   61  * A notification callback function which is called from
   62  * taskqueue_enqueue().  The context argument is given in the call to
   63  * taskqueue_create().  This function would normally be used to allow the
   64  * queue to arrange to run itself later (e.g., by scheduling a software
   65  * interrupt or waking a kernel thread).
   66  */
   67 typedef void (*taskqueue_enqueue_fn)(void *context);
   68 
   69 struct taskqueue *taskqueue_create(const char *name, int mflags,
   70                                     taskqueue_enqueue_fn enqueue,
   71                                     void *context);
   72 int     taskqueue_start_threads(struct taskqueue **tqp, int count, int pri,
   73                                 const char *name, ...) __printflike(4, 5);
   74 int     taskqueue_enqueue(struct taskqueue *queue, struct task *task);
   75 int     taskqueue_enqueue_timeout(struct taskqueue *queue,
   76             struct timeout_task *timeout_task, int ticks);
   77 int     taskqueue_cancel(struct taskqueue *queue, struct task *task,
   78             u_int *pendp);
   79 int     taskqueue_cancel_timeout(struct taskqueue *queue,
   80             struct timeout_task *timeout_task, u_int *pendp);
   81 void    taskqueue_drain(struct taskqueue *queue, struct task *task);
   82 void    taskqueue_drain_timeout(struct taskqueue *queue,
   83             struct timeout_task *timeout_task);
   84 void    taskqueue_free(struct taskqueue *queue);
   85 void    taskqueue_run(struct taskqueue *queue);
   86 void    taskqueue_block(struct taskqueue *queue);
   87 void    taskqueue_unblock(struct taskqueue *queue);
   88 int     taskqueue_member(struct taskqueue *queue, struct thread *td);
   89 void    taskqueue_set_callback(struct taskqueue *queue,
   90             enum taskqueue_callback_type cb_type,
   91             taskqueue_callback_fn callback, void *context);
   92 
   93 #define TASK_INITIALIZER(priority, func, context)       \
   94         { .ta_pending = 0,                              \
   95           .ta_priority = (priority),                    \
   96           .ta_func = (func),                            \
   97           .ta_context = (context) }
   98 
   99 /*
  100  * Functions for dedicated thread taskqueues
  101  */
  102 void    taskqueue_thread_loop(void *arg);
  103 void    taskqueue_thread_enqueue(void *context);
  104 
  105 /*
  106  * Initialise a task structure.
  107  */
  108 #define TASK_INIT(task, priority, func, context) do {   \
  109         (task)->ta_pending = 0;                         \
  110         (task)->ta_priority = (priority);               \
  111         (task)->ta_func = (func);                       \
  112         (task)->ta_context = (context);                 \
  113 } while (0)
  114 
  115 void _timeout_task_init(struct taskqueue *queue,
  116             struct timeout_task *timeout_task, int priority, task_fn_t func,
  117             void *context);
  118 #define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) \
  119         _timeout_task_init(queue, timeout_task, priority, func, context);
  120 
  121 /*
  122  * Declare a reference to a taskqueue.
  123  */
  124 #define TASKQUEUE_DECLARE(name)                 \
  125 extern struct taskqueue *taskqueue_##name
  126 
  127 /*
  128  * Define and initialise a global taskqueue that uses sleep mutexes.
  129  */
  130 #define TASKQUEUE_DEFINE(name, enqueue, context, init)                  \
  131                                                                         \
  132 struct taskqueue *taskqueue_##name;                                     \
  133                                                                         \
  134 static void                                                             \
  135 taskqueue_define_##name(void *arg)                                      \
  136 {                                                                       \
  137         taskqueue_##name =                                              \
  138             taskqueue_create(#name, M_WAITOK, (enqueue), (context));    \
  139         init;                                                           \
  140 }                                                                       \
  141                                                                         \
  142 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND,            \
  143         taskqueue_define_##name, NULL);                                 \
  144                                                                         \
  145 struct __hack
  146 #define TASKQUEUE_DEFINE_THREAD(name)                                   \
  147 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name,     \
  148         taskqueue_start_threads(&taskqueue_##name, 1, PWAIT,            \
  149         "%s taskq", #name))
  150 
  151 /*
  152  * Define and initialise a global taskqueue that uses spin mutexes.
  153  */
  154 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init)             \
  155                                                                         \
  156 struct taskqueue *taskqueue_##name;                                     \
  157                                                                         \
  158 static void                                                             \
  159 taskqueue_define_##name(void *arg)                                      \
  160 {                                                                       \
  161         taskqueue_##name =                                              \
  162             taskqueue_create_fast(#name, M_WAITOK, (enqueue),           \
  163             (context));                                                 \
  164         init;                                                           \
  165 }                                                                       \
  166                                                                         \
  167 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND,            \
  168         taskqueue_define_##name, NULL);                                 \
  169                                                                         \
  170 struct __hack
  171 #define TASKQUEUE_FAST_DEFINE_THREAD(name)                              \
  172 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue,                   \
  173         &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name    \
  174         1, PWAIT, "%s taskq", #name))
  175 
  176 /*
  177  * These queues are serviced by software interrupt handlers.  To enqueue
  178  * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
  179  * taskqueue_enqueue(taskqueue_swi_giant, &task).
  180  */
  181 TASKQUEUE_DECLARE(swi_giant);
  182 TASKQUEUE_DECLARE(swi);
  183 
  184 /*
  185  * This queue is serviced by a kernel thread.  To enqueue a task, call
  186  * taskqueue_enqueue(taskqueue_thread, &task).
  187  */
  188 TASKQUEUE_DECLARE(thread);
  189 
  190 /*
  191  * Queue for swi handlers dispatched from fast interrupt handlers.
  192  * These are necessarily different from the above because the queue
  193  * must be locked with spinlocks since sleep mutex's cannot be used
  194  * from a fast interrupt handler context.
  195  */
  196 TASKQUEUE_DECLARE(fast);
  197 int     taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task);
  198 struct taskqueue *taskqueue_create_fast(const char *name, int mflags,
  199                                     taskqueue_enqueue_fn enqueue,
  200                                     void *context);
  201 
  202 #endif /* !_SYS_TASKQUEUE_H_ */

Cache object: d62d2bcd4012ae0a74fb80f20df0dc60

[ 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