161033Sdfr/*- 261033Sdfr * Copyright (c) 2000 Doug Rabson 361033Sdfr * All rights reserved. 461033Sdfr * 561033Sdfr * Redistribution and use in source and binary forms, with or without 661033Sdfr * modification, are permitted provided that the following conditions 761033Sdfr * are met: 861033Sdfr * 1. Redistributions of source code must retain the above copyright 961033Sdfr * notice, this list of conditions and the following disclaimer. 1061033Sdfr * 2. Redistributions in binary form must reproduce the above copyright 1161033Sdfr * notice, this list of conditions and the following disclaimer in the 1261033Sdfr * documentation and/or other materials provided with the distribution. 1361033Sdfr * 1461033Sdfr * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1561033Sdfr * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1661033Sdfr * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1761033Sdfr * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1861033Sdfr * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1961033Sdfr * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2061033Sdfr * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2161033Sdfr * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2261033Sdfr * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2361033Sdfr * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2461033Sdfr * SUCH DAMAGE. 2561033Sdfr * 2661086Sdfr * $FreeBSD$ 2761033Sdfr */ 2861033Sdfr 2961033Sdfr#ifndef _SYS_TASKQUEUE_H_ 3061033Sdfr#define _SYS_TASKQUEUE_H_ 3161033Sdfr 3261086Sdfr#ifndef _KERNEL 3361086Sdfr#error "no user-servicable parts inside" 3461086Sdfr#endif 3561033Sdfr 3661086Sdfr#include <sys/queue.h> 37124882Srwatson#include <sys/_task.h> 38221059Skib#include <sys/_callout.h> 3961086Sdfr 4061033Sdfrstruct taskqueue; 41196295Spjdstruct thread; 4261033Sdfr 43221059Skibstruct timeout_task { 44221059Skib struct taskqueue *q; 45221059Skib struct task t; 46221059Skib struct callout c; 47221059Skib int f; 48221059Skib}; 49221059Skib 5061033Sdfr/* 5161033Sdfr * A notification callback function which is called from 5261086Sdfr * taskqueue_enqueue(). The context argument is given in the call to 5361086Sdfr * taskqueue_create(). This function would normally be used to allow the 5461086Sdfr * queue to arrange to run itself later (e.g., by scheduling a software 5561033Sdfr * interrupt or waking a kernel thread). 5661033Sdfr */ 5761033Sdfrtypedef void (*taskqueue_enqueue_fn)(void *context); 5861033Sdfr 5961086Sdfrstruct taskqueue *taskqueue_create(const char *name, int mflags, 6061086Sdfr taskqueue_enqueue_fn enqueue, 61154333Sscottl void *context); 62154333Sscottlint taskqueue_start_threads(struct taskqueue **tqp, int count, int pri, 63154333Sscottl const char *name, ...) __printflike(4, 5); 6461086Sdfrint taskqueue_enqueue(struct taskqueue *queue, struct task *task); 65221059Skibint taskqueue_enqueue_timeout(struct taskqueue *queue, 66221059Skib struct timeout_task *timeout_task, int ticks); 67215011Smdfint taskqueue_cancel(struct taskqueue *queue, struct task *task, 68215011Smdf u_int *pendp); 69221059Skibint taskqueue_cancel_timeout(struct taskqueue *queue, 70221059Skib struct timeout_task *timeout_task, u_int *pendp); 71136131Simpvoid taskqueue_drain(struct taskqueue *queue, struct task *task); 72221059Skibvoid taskqueue_drain_timeout(struct taskqueue *queue, 73221059Skib struct timeout_task *timeout_task); 74262064Savgvoid taskqueue_drain_all(struct taskqueue *queue); 7561086Sdfrvoid taskqueue_free(struct taskqueue *queue); 76213813Smdfvoid taskqueue_run(struct taskqueue *queue); 77177621Sscottlvoid taskqueue_block(struct taskqueue *queue); 78177621Sscottlvoid taskqueue_unblock(struct taskqueue *queue); 79196295Spjdint taskqueue_member(struct taskqueue *queue, struct thread *td); 8061033Sdfr 81230012Sjhb#define TASK_INITIALIZER(priority, func, context) \ 82230012Sjhb { .ta_pending = 0, \ 83230012Sjhb .ta_priority = (priority), \ 84230012Sjhb .ta_func = (func), \ 85230012Sjhb .ta_context = (context) } 86230012Sjhb 8761033Sdfr/* 88133305Sjmg * Functions for dedicated thread taskqueues 89133305Sjmg */ 90133305Sjmgvoid taskqueue_thread_loop(void *arg); 91133305Sjmgvoid taskqueue_thread_enqueue(void *context); 92133305Sjmg 93133305Sjmg/* 9461033Sdfr * Initialise a task structure. 9561033Sdfr */ 9685560Sjhb#define TASK_INIT(task, priority, func, context) do { \ 9785560Sjhb (task)->ta_pending = 0; \ 9885560Sjhb (task)->ta_priority = (priority); \ 9985560Sjhb (task)->ta_func = (func); \ 10085560Sjhb (task)->ta_context = (context); \ 10185560Sjhb} while (0) 10261033Sdfr 103221059Skibvoid _timeout_task_init(struct taskqueue *queue, 104221059Skib struct timeout_task *timeout_task, int priority, task_fn_t func, 105221059Skib void *context); 106221059Skib#define TIMEOUT_TASK_INIT(queue, timeout_task, priority, func, context) \ 107221059Skib _timeout_task_init(queue, timeout_task, priority, func, context); 108221059Skib 10961033Sdfr/* 11061033Sdfr * Declare a reference to a taskqueue. 11161033Sdfr */ 11261033Sdfr#define TASKQUEUE_DECLARE(name) \ 11361033Sdfrextern struct taskqueue *taskqueue_##name 11461033Sdfr 11561033Sdfr/* 116154167Sscottl * Define and initialise a global taskqueue that uses sleep mutexes. 11761033Sdfr */ 11861086Sdfr#define TASKQUEUE_DEFINE(name, enqueue, context, init) \ 11961033Sdfr \ 12061033Sdfrstruct taskqueue *taskqueue_##name; \ 12161033Sdfr \ 12261033Sdfrstatic void \ 12361033Sdfrtaskqueue_define_##name(void *arg) \ 12461033Sdfr{ \ 12561033Sdfr taskqueue_##name = \ 126218270Sjhb taskqueue_create(#name, M_WAITOK, (enqueue), (context)); \ 12761033Sdfr init; \ 12861033Sdfr} \ 12961033Sdfr \ 13061033SdfrSYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 131177253Srwatson taskqueue_define_##name, NULL); \ 13261086Sdfr \ 13361086Sdfrstruct __hack 134133305Sjmg#define TASKQUEUE_DEFINE_THREAD(name) \ 135133305SjmgTASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \ 136154333Sscottl taskqueue_start_threads(&taskqueue_##name, 1, PWAIT, \ 137154333Sscottl "%s taskq", #name)) 13861033Sdfr 13961033Sdfr/* 140154167Sscottl * Define and initialise a global taskqueue that uses spin mutexes. 141154167Sscottl */ 142154167Sscottl#define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \ 143154167Sscottl \ 144154167Sscottlstruct taskqueue *taskqueue_##name; \ 145154167Sscottl \ 146154167Sscottlstatic void \ 147154167Sscottltaskqueue_define_##name(void *arg) \ 148154167Sscottl{ \ 149154167Sscottl taskqueue_##name = \ 150218270Sjhb taskqueue_create_fast(#name, M_WAITOK, (enqueue), \ 151154333Sscottl (context)); \ 152154167Sscottl init; \ 153154167Sscottl} \ 154154167Sscottl \ 155154167SscottlSYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 156177253Srwatson taskqueue_define_##name, NULL); \ 157154167Sscottl \ 158154167Sscottlstruct __hack 159154167Sscottl#define TASKQUEUE_FAST_DEFINE_THREAD(name) \ 160154167SscottlTASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \ 161154333Sscottl &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name \ 162154333Sscottl 1, PWAIT, "%s taskq", #name)) 163154167Sscottl 164154167Sscottl/* 165119708Sken * These queues are serviced by software interrupt handlers. To enqueue 166119708Sken * a task, call taskqueue_enqueue(taskqueue_swi, &task) or 167119708Sken * taskqueue_enqueue(taskqueue_swi_giant, &task). 16861033Sdfr */ 169111528SscottlTASKQUEUE_DECLARE(swi_giant); 17061033SdfrTASKQUEUE_DECLARE(swi); 17161033Sdfr 172119708Sken/* 173119708Sken * This queue is serviced by a kernel thread. To enqueue a task, call 174119708Sken * taskqueue_enqueue(taskqueue_thread, &task). 175119708Sken */ 176119708SkenTASKQUEUE_DECLARE(thread); 177119708Sken 178119789Ssam/* 179119789Ssam * Queue for swi handlers dispatched from fast interrupt handlers. 180119789Ssam * These are necessarily different from the above because the queue 181119789Ssam * must be locked with spinlocks since sleep mutex's cannot be used 182119789Ssam * from a fast interrupt handler context. 183119789Ssam */ 184119789SsamTASKQUEUE_DECLARE(fast); 185119789Ssamint taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task); 186154167Sscottlstruct taskqueue *taskqueue_create_fast(const char *name, int mflags, 187154167Sscottl taskqueue_enqueue_fn enqueue, 188154333Sscottl void *context); 189119789Ssam 19061033Sdfr#endif /* !_SYS_TASKQUEUE_H_ */ 191