taskqueue.h revision 177621
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: head/sys/sys/taskqueue.h 177621 2008-03-25 22:38:45Z scottl $ 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> 3861086Sdfr 3961033Sdfrstruct taskqueue; 4061033Sdfr 4161033Sdfr/* 4261033Sdfr * A notification callback function which is called from 4361086Sdfr * taskqueue_enqueue(). The context argument is given in the call to 4461086Sdfr * taskqueue_create(). This function would normally be used to allow the 4561086Sdfr * queue to arrange to run itself later (e.g., by scheduling a software 4661033Sdfr * interrupt or waking a kernel thread). 4761033Sdfr */ 4861033Sdfrtypedef void (*taskqueue_enqueue_fn)(void *context); 4961033Sdfr 50145729Ssamstruct proc; 5161086Sdfrstruct taskqueue *taskqueue_create(const char *name, int mflags, 5261086Sdfr taskqueue_enqueue_fn enqueue, 53154333Sscottl void *context); 54154333Sscottlint taskqueue_start_threads(struct taskqueue **tqp, int count, int pri, 55154333Sscottl const char *name, ...) __printflike(4, 5); 5661086Sdfrint taskqueue_enqueue(struct taskqueue *queue, struct task *task); 57136131Simpvoid taskqueue_drain(struct taskqueue *queue, struct task *task); 5861086Sdfrstruct taskqueue *taskqueue_find(const char *name); 5961086Sdfrvoid taskqueue_free(struct taskqueue *queue); 6061086Sdfrvoid taskqueue_run(struct taskqueue *queue); 61177621Sscottlvoid taskqueue_block(struct taskqueue *queue); 62177621Sscottlvoid taskqueue_unblock(struct taskqueue *queue); 6361033Sdfr 6461033Sdfr/* 65133305Sjmg * Functions for dedicated thread taskqueues 66133305Sjmg */ 67133305Sjmgvoid taskqueue_thread_loop(void *arg); 68133305Sjmgvoid taskqueue_thread_enqueue(void *context); 69133305Sjmg 70133305Sjmg/* 7161033Sdfr * Initialise a task structure. 7261033Sdfr */ 7385560Sjhb#define TASK_INIT(task, priority, func, context) do { \ 7485560Sjhb (task)->ta_pending = 0; \ 7585560Sjhb (task)->ta_priority = (priority); \ 7685560Sjhb (task)->ta_func = (func); \ 7785560Sjhb (task)->ta_context = (context); \ 7885560Sjhb} while (0) 7961033Sdfr 8061033Sdfr/* 8161033Sdfr * Declare a reference to a taskqueue. 8261033Sdfr */ 8361033Sdfr#define TASKQUEUE_DECLARE(name) \ 8461033Sdfrextern struct taskqueue *taskqueue_##name 8561033Sdfr 8661033Sdfr/* 87154167Sscottl * Define and initialise a global taskqueue that uses sleep mutexes. 8861033Sdfr */ 8961086Sdfr#define TASKQUEUE_DEFINE(name, enqueue, context, init) \ 9061033Sdfr \ 9161033Sdfrstruct taskqueue *taskqueue_##name; \ 9261033Sdfr \ 9361033Sdfrstatic void \ 9461033Sdfrtaskqueue_define_##name(void *arg) \ 9561033Sdfr{ \ 9661033Sdfr taskqueue_##name = \ 97154333Sscottl taskqueue_create(#name, M_NOWAIT, (enqueue), (context)); \ 9861033Sdfr init; \ 9961033Sdfr} \ 10061033Sdfr \ 10161033SdfrSYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 102177253Srwatson taskqueue_define_##name, NULL); \ 10361086Sdfr \ 10461086Sdfrstruct __hack 105133305Sjmg#define TASKQUEUE_DEFINE_THREAD(name) \ 106133305SjmgTASKQUEUE_DEFINE(name, taskqueue_thread_enqueue, &taskqueue_##name, \ 107154333Sscottl taskqueue_start_threads(&taskqueue_##name, 1, PWAIT, \ 108154333Sscottl "%s taskq", #name)) 10961033Sdfr 11061033Sdfr/* 111154167Sscottl * Define and initialise a global taskqueue that uses spin mutexes. 112154167Sscottl */ 113154167Sscottl#define TASKQUEUE_FAST_DEFINE(name, enqueue, context, init) \ 114154167Sscottl \ 115154167Sscottlstruct taskqueue *taskqueue_##name; \ 116154167Sscottl \ 117154167Sscottlstatic void \ 118154167Sscottltaskqueue_define_##name(void *arg) \ 119154167Sscottl{ \ 120154167Sscottl taskqueue_##name = \ 121154333Sscottl taskqueue_create_fast(#name, M_NOWAIT, (enqueue), \ 122154333Sscottl (context)); \ 123154167Sscottl init; \ 124154167Sscottl} \ 125154167Sscottl \ 126154167SscottlSYSINIT(taskqueue_##name, SI_SUB_CONFIGURE, SI_ORDER_SECOND, \ 127177253Srwatson taskqueue_define_##name, NULL); \ 128154167Sscottl \ 129154167Sscottlstruct __hack 130154167Sscottl#define TASKQUEUE_FAST_DEFINE_THREAD(name) \ 131154167SscottlTASKQUEUE_FAST_DEFINE(name, taskqueue_thread_enqueue, \ 132154333Sscottl &taskqueue_##name, taskqueue_start_threads(&taskqueue_##name \ 133154333Sscottl 1, PWAIT, "%s taskq", #name)) 134154167Sscottl 135154167Sscottl/* 136119708Sken * These queues are serviced by software interrupt handlers. To enqueue 137119708Sken * a task, call taskqueue_enqueue(taskqueue_swi, &task) or 138119708Sken * taskqueue_enqueue(taskqueue_swi_giant, &task). 13961033Sdfr */ 140111528SscottlTASKQUEUE_DECLARE(swi_giant); 14161033SdfrTASKQUEUE_DECLARE(swi); 14261033Sdfr 143119708Sken/* 144119708Sken * This queue is serviced by a kernel thread. To enqueue a task, call 145119708Sken * taskqueue_enqueue(taskqueue_thread, &task). 146119708Sken */ 147119708SkenTASKQUEUE_DECLARE(thread); 148119708Sken 149119789Ssam/* 150119789Ssam * Queue for swi handlers dispatched from fast interrupt handlers. 151119789Ssam * These are necessarily different from the above because the queue 152119789Ssam * must be locked with spinlocks since sleep mutex's cannot be used 153119789Ssam * from a fast interrupt handler context. 154119789Ssam */ 155119789SsamTASKQUEUE_DECLARE(fast); 156119789Ssamint taskqueue_enqueue_fast(struct taskqueue *queue, struct task *task); 157154167Sscottlstruct taskqueue *taskqueue_create_fast(const char *name, int mflags, 158154167Sscottl taskqueue_enqueue_fn enqueue, 159154333Sscottl void *context); 160119789Ssam 16161033Sdfr#endif /* !_SYS_TASKQUEUE_H_ */ 162