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

Cache object: 5a737a73cb13c7d6e44e097fa3cb80b7


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