add a simple "do it in thread context" framework.

This commit is contained in:
yamt 2005-10-29 11:10:37 +00:00
parent 0416d5be24
commit 54f971f435
2 changed files with 264 additions and 0 deletions

211
sys/kern/subr_workqueue.c Normal file
View File

@ -0,0 +1,211 @@
/* $NetBSD: subr_workqueue.c,v 1.1 2005/10/29 11:10:37 yamt Exp $ */
/*-
* Copyright (c)2002, 2005 YAMAMOTO Takashi,
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: subr_workqueue.c,v 1.1 2005/10/29 11:10:37 yamt Exp $");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kthread.h>
#include <sys/malloc.h>
#include <sys/proc.h>
#include <sys/workqueue.h>
SIMPLEQ_HEAD(workqhead, work);
struct workqueue_queue {
struct simplelock q_lock;
int q_savedipl;
struct workqhead q_queue;
struct proc *q_worker;
};
struct workqueue {
struct workqueue_queue wq_queue; /* todo: make this per-cpu */
void (*wq_func)(struct work *, void *);
void *wq_arg;
const char *wq_name;
int wq_prio;
int wq_ipl;
};
MALLOC_DEFINE(M_WORKQUEUE, "workqueue", "work queue");
#define POISON 0xaabbccdd
static void
workqueue_lock(struct workqueue *wq, struct workqueue_queue *q)
{
int s;
#if 0 /* notyet */
s = splraiseipl(wq->wq_ipl);
#else
s = splhigh(); /* XXX */
#endif
simple_lock(&q->q_lock);
q->q_savedipl = s;
}
static void
workqueue_unlock(struct workqueue *wq, struct workqueue_queue *q)
{
int s = q->q_savedipl;
simple_unlock(&q->q_lock);
splx(s);
}
static void
workqueue_runlist(struct workqueue *wq, struct workqhead *list)
{
struct work *wk;
struct work *next;
/*
* note that "list" is not a complete SIMPLEQ.
*/
for (wk = SIMPLEQ_FIRST(list); wk != NULL; wk = next) {
next = SIMPLEQ_NEXT(wk, wk_entry);
(*wq->wq_func)(wk, wq->wq_arg);
}
}
static void
workqueue_run(struct workqueue *wq)
{
struct workqueue_queue *q = &wq->wq_queue;
while (1 /* CONSTCOND */) {
struct workqhead tmp;
int error;
/*
* we violate abstraction of SIMPLEQ.
*/
#if defined(DIAGNOSTIC)
tmp.sqh_last = (void *)POISON;
#endif /* defined(DIAGNOSTIC) */
workqueue_lock(wq, q);
while (SIMPLEQ_EMPTY(&q->q_queue)) {
error = ltsleep(q, wq->wq_prio, wq->wq_name, 0,
&q->q_lock);
if (error) {
panic("%s: %s error=%d",
__func__, wq->wq_name, error);
}
}
tmp.sqh_first = q->q_queue.sqh_first; /* XXX */
SIMPLEQ_INIT(&q->q_queue);
workqueue_unlock(wq, q);
workqueue_runlist(wq, &tmp);
}
}
static void
workqueue_worker(void *arg)
{
struct workqueue *wq = arg;
workqueue_run(wq);
}
static void
workqueue_init(struct workqueue *wq, const char *name,
void (*callback_func)(struct work *, void *), void *callback_arg,
int prio, int ipl)
{
wq->wq_ipl = ipl;
wq->wq_prio = prio;
wq->wq_name = name;
wq->wq_func = callback_func;
wq->wq_arg = callback_arg;
}
static int
workqueue_initqueue(struct workqueue *wq)
{
struct workqueue_queue *q = &wq->wq_queue;
int error;
simple_lock_init(&q->q_lock);
SIMPLEQ_INIT(&q->q_queue);
error = kthread_create1(workqueue_worker, wq, &q->q_worker,
wq->wq_name);
return error;
}
/* --- */
int
workqueue_create(struct workqueue **wqp, const char *name,
void (*callback_func)(struct work *, void *), void *callback_arg,
int prio, int ipl, int flags)
{
struct workqueue *wq;
int error;
wq = malloc(sizeof(*wq), M_WORKQUEUE, 0);
if (wq == NULL) {
return ENOMEM;
}
workqueue_init(wq, name, callback_func, callback_arg, prio, ipl);
error = workqueue_initqueue(wq);
if (error) {
free(wq, M_WORKQUEUE);
return error;
}
*wqp = wq;
return 0;
}
void
workqueue_enqueue(struct workqueue *wq, struct work *wk)
{
struct workqueue_queue *q = &wq->wq_queue;
boolean_t wasempty;
workqueue_lock(wq, q);
wasempty = SIMPLEQ_EMPTY(&q->q_queue);
SIMPLEQ_INSERT_TAIL(&q->q_queue, wk, wk_entry);
workqueue_unlock(wq, q);
if (wasempty) {
wakeup(q);
}
}

53
sys/sys/workqueue.h Normal file
View File

@ -0,0 +1,53 @@
/* $NetBSD: workqueue.h,v 1.1 2005/10/29 11:10:37 yamt Exp $ */
/*-
* Copyright (c)2002, 2005 YAMAMOTO Takashi,
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#if !defined(_SYS_WORKQUEUE_H_)
#define _SYS_WORKQUEUE_H_
#include <sys/queue.h>
/*
* a simple "do it in thread context" framework.
*
* this framework is designed to make struct work small as
* far as possible, so that it can be embedded into other structures
* without too much cost.
*/
struct work {
SIMPLEQ_ENTRY(work) wk_entry;
};
struct workqueue;
int workqueue_create(struct workqueue **, const char *,
void (*)(struct work *, void *), void *, int, int, int);
void workqueue_enqueue(struct workqueue *, struct work *);
#endif /* !defined(_SYS_WORKQUEUE_H_) */