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

Cache object: 5d0b781268c719f113745f831c6c5d72

[ 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