a724d49f4932e4ceda8e87cf6da7e13db9e9ef71
[dragonfly.git] / sys / platform / vkernel / platform / cothread.c
1 /*
2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
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  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/platform/vkernel/platform/cothread.c,v 1.2 2008/03/27 04:28:09 dillon Exp $
35  */
36 /*
37  * Provides the vkernel with an asynchronous I/O mechanism using pthreads
38  * which operates outside the cpu abstraction.  Cothreads are intended to
39  * operate like DMA engines and may ONLY make libc and cothread_*() calls.
40  * The cothread may NOT call into the vkernel since abstractions like
41  * 'mycpu' do not exist for it. 
42  */
43
44 #include <sys/interrupt.h>
45 #include <sys/kernel.h>
46 #include <sys/memrange.h>
47 #include <sys/tls.h>
48 #include <sys/types.h>
49
50 #include <vm/vm_extern.h>
51 #include <vm/vm_kern.h>
52 #include <vm/vm_object.h>
53 #include <vm/vm_page.h>
54
55 #include <machine/cpu.h>
56 #include <machine/cpufunc.h>
57 #include <machine/globaldata.h>
58 #include <machine/md_var.h>
59 #include <machine/pmap.h>
60 #include <machine/smp.h>
61 #include <machine/tls.h>
62 #include <machine/cothread.h>
63
64 #include <unistd.h>
65 #include <pthread.h>
66 #include <signal.h>
67 #include <stdio.h>
68
69 static void cothread_thread(void *arg);
70
71 /*
72  * Create a co-processor thread for a virtual kernel.  This thread operates
73  * outside of the virtual kernel cpu abstraction and may only make direct
74  * cothread and libc calls.
75  */
76 cothread_t
77 cothread_create(void (*thr_func)(cothread_t cotd),
78                 void (*thr_intr)(cothread_t cotd),
79                 void *arg, const char *name)
80 {
81         cothread_t cotd;
82
83         cotd = kmalloc(sizeof(*cotd), M_DEVBUF, M_WAITOK|M_ZERO);
84         cotd->thr_intr = thr_intr;
85         cotd->thr_func = thr_func;
86         cotd->arg = arg;
87         pthread_mutex_init(&cotd->mutex, NULL);
88         pthread_cond_init(&cotd->cond, NULL);
89
90         cotd->pintr = pthread_self();
91
92         register_int(1, (void *)thr_intr, cotd, name, NULL, 0);
93
94         /*
95          * The vkernel's cpu_disable_intr() masks signals.  We don't want
96          * our coprocessor thread taking any unix signals :-)
97          */
98         pthread_create(&cotd->pthr, NULL, (void *)cothread_thread, cotd);
99         return(cotd);
100 }
101
102 static void
103 cothread_thread(void *arg)
104 {
105         cothread_t cotd = arg;
106         int dummy = 0;
107
108         cpu_mask_all_signals();
109         /* %fs (aka mycpu) is illegal in cothreads */
110         tls_set_fs(&dummy, sizeof(dummy));
111         cotd->thr_func(cotd);
112 }
113
114 /*
115  * Called by the cothread to generate an interrupt back to the vkernel.
116  */
117 void
118 cothread_intr(cothread_t cotd)
119 {
120         pthread_kill(cotd->pintr, SIGIO);
121 }
122
123 /*
124  * Called by the vkernel to wakeup a cothread.
125  */
126 void
127 cothread_signal(cothread_t cotd)
128 {
129         pthread_cond_signal(&cotd->cond);
130 }
131
132 /*
133  * Called by the cothread to wait for the vkernel to call cothread_signal().
134  */
135 void
136 cothread_wait(cothread_t cotd)
137 {
138         pthread_cond_wait(&cotd->cond, &cotd->mutex);
139 }
140
141 void
142 cothread_lock(cothread_t cotd)
143 {
144         pthread_mutex_lock(&cotd->mutex);
145 }
146
147 void
148 cothread_unlock(cothread_t cotd)
149 {
150         pthread_mutex_unlock(&cotd->mutex);
151 }
152