The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/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.0/sys/sys/taskqueue.h 221059 2011-04-26 11:39:56Z kib $
   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 /*
   81  * Functions for dedicated thread taskqueues
   82  */
   83 void    taskqueue_thread_loop(void *arg);
   84 void    taskqueue_thread_enqueue(void *context);
   85 
   86 /*
   87  * Initialise a task structure.
   88  */
   89 #define TASK_INIT(task, priority, func, context) do {   \
   90         (task)->ta_pending = 0;                         \
   91         (task)->ta_priority = (priority);               \
   92         (task)->ta_func = (func);                       \
   93         (task)->ta_context = (context);                 \
   94 } while (0)
   95 
   96 void _timeout_task_init(struct taskqueue *queue,
   97             struct timeout_task *timeout_task, int priority, task_fn_t func,
   98             void *context);
   99 #define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) \
  100         _timeout_task_init(queue, timeout_task, priority, func, context);
  101 
  102 /*
  103  * Declare a reference to a taskqueue.
  104  */
  105 #define TASKQUEUE_DECLARE(name)                 \
  106 extern struct taskqueue *taskqueue_##name
  107 
  108 /*
  109  * Define and initialise a global taskqueue that uses sleep mutexes.
  110  */
  111 #define TASKQUEUE_DEFINE(name, enqueue, context, init)                  \
  112                                                                         \
  113 struct taskqueue *taskqueue_##name;                                     \
  114                                                                         \
  115 static void                                                             \
  116 taskqueue_define_##name(void *arg)                                      \
  117 {                                                                       \
  118         taskqueue_##name =                                              \
  119             taskqueue_create(#name, M_WAITOK, (enqueue), (context));    \
  120         init;                                                           \
  121 }                                                                       \
  122                                                                         \
  123 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND,            \
  124         taskqueue_define_##name, NULL);                                 \
  125                                                                         \
  126 struct __hack
  127 #define TASKQUEUE_DEFINE_THREAD(name)                                   \
  128 TASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name,     \
  129         taskqueue_start_threads(&taskqueue_##name, 1, PWAIT,            \
  130         "%s taskq", #name))
  131 
  132 /*
  133  * Define and initialise a global taskqueue that uses spin mutexes.
  134  */
  135 #define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init)             \
  136                                                                         \
  137 struct taskqueue *taskqueue_##name;                                     \
  138                                                                         \
  139 static void                                                             \
  140 taskqueue_define_##name(void *arg)                                      \
  141 {                                                                       \
  142         taskqueue_##name =                                              \
  143             taskqueue_create_fast(#name, M_WAITOK, (enqueue),           \
  144             (context));                                                 \
  145         init;                                                           \
  146 }                                                                       \
  147                                                                         \
  148 SYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND,            \
  149         taskqueue_define_##name, NULL);                                 \
  150                                                                         \
  151 struct __hack
  152 #define TASKQUEUE_FAST_DEFINE_THREAD(name)                              \
  153 TASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue,                   \
  154         &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name    \
  155         1, PWAIT, "%s taskq", #name))
  156 
  157 /*
  158  * These queues are serviced by software interrupt handlers.  To enqueue
  159  * a task, call taskqueue_enqueue(taskqueue_swi, &task) or
  160  * taskqueue_enqueue(taskqueue_swi_giant, &task).
  161  */
  162 TASKQUEUE_DECLARE(swi_giant);
  163 TASKQUEUE_DECLARE(swi);
  164 
  165 /*
  166  * This queue is serviced by a kernel thread.  To enqueue a task, call
  167  * taskqueue_enqueue(taskqueue_thread, &task).
  168  */
  169 TASKQUEUE_DECLARE(thread);
  170 
  171 /*
  172  * Queue for swi handlers dispatched from fast interrupt handlers.
  173  * These are necessarily different from the above because the queue
  174  * must be locked with spinlocks since sleep mutex's cannot be used
  175  * from a fast interrupt handler context.
  176  */
  177 TASKQUEUE_DECLARE(fast);
  178 int     taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task);
  179 struct taskqueue *taskqueue_create_fast(const char *name, int mflags,
  180                                     taskqueue_enqueue_fn enqueue,
  181                                     void *context);
  182 
  183 #endif /* !_SYS_TASKQUEUE_H_ */

Cache object: 81ad859477e149d3553fabba0c74d5e1


[ 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.