Rev 1084 | Rev 1088 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
955 | palkovsky | 1 | /* |
2 | * Copyright (C) 2006 Ondrej Palkovsky |
||
3 | * All rights reserved. |
||
4 | * |
||
5 | * Redistribution and use in source and binary forms, with or without |
||
6 | * modification, are permitted provided that the following conditions |
||
7 | * are met: |
||
8 | * |
||
9 | * - Redistributions of source code must retain the above copyright |
||
10 | * notice, this list of conditions and the following disclaimer. |
||
11 | * - Redistributions in binary form must reproduce the above copyright |
||
12 | * notice, this list of conditions and the following disclaimer in the |
||
13 | * documentation and/or other materials provided with the distribution. |
||
14 | * - The name of the author may not be used to endorse or promote products |
||
15 | * derived from this software without specific prior written permission. |
||
16 | * |
||
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
||
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
||
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
||
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
||
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
27 | */ |
||
28 | |||
29 | /* Lock ordering |
||
30 | * |
||
31 | * First the answerbox, then the phone |
||
32 | */ |
||
33 | |||
1040 | palkovsky | 34 | #include <synch/spinlock.h> |
35 | #include <synch/waitq.h> |
||
955 | palkovsky | 36 | #include <ipc/ipc.h> |
37 | #include <errno.h> |
||
38 | #include <mm/slab.h> |
||
39 | #include <arch.h> |
||
40 | #include <proc/task.h> |
||
41 | #include <memstr.h> |
||
42 | #include <debug.h> |
||
43 | |||
44 | #include <print.h> |
||
45 | #include <proc/thread.h> |
||
46 | |||
965 | palkovsky | 47 | /* Open channel that is assigned automatically to new tasks */ |
48 | answerbox_t *ipc_phone_0 = NULL; |
||
955 | palkovsky | 49 | |
50 | static slab_cache_t *ipc_call_slab; |
||
51 | |||
1084 | palkovsky | 52 | /* Initialize new call */ |
53 | static void _ipc_call_init(call_t *call) |
||
54 | { |
||
55 | memsetb((__address)call, sizeof(*call), 0); |
||
56 | call->callerbox = &TASK->answerbox; |
||
57 | call->sender = TASK; |
||
58 | } |
||
59 | |||
955 | palkovsky | 60 | /** Allocate & initialize call structure |
61 | * |
||
62 | * The call is initialized, so that the reply will be directed |
||
63 | * to TASK->answerbox |
||
64 | */ |
||
65 | call_t * ipc_call_alloc(void) |
||
66 | { |
||
67 | call_t *call; |
||
68 | |||
69 | call = slab_alloc(ipc_call_slab, 0); |
||
1084 | palkovsky | 70 | _ipc_call_init(call); |
955 | palkovsky | 71 | |
72 | return call; |
||
73 | } |
||
74 | |||
965 | palkovsky | 75 | /** Initialize allocated call */ |
1084 | palkovsky | 76 | void ipc_call_static_init(call_t *call) |
965 | palkovsky | 77 | { |
1084 | palkovsky | 78 | _ipc_call_init(call); |
79 | call->flags |= IPC_CALL_STATIC_ALLOC; |
||
965 | palkovsky | 80 | } |
81 | |||
955 | palkovsky | 82 | /** Deallocate call stracuture */ |
83 | void ipc_call_free(call_t *call) |
||
84 | { |
||
85 | slab_free(ipc_call_slab, call); |
||
86 | } |
||
87 | |||
88 | /** Initialize answerbox structure |
||
89 | */ |
||
90 | void ipc_answerbox_init(answerbox_t *box) |
||
91 | { |
||
1040 | palkovsky | 92 | spinlock_initialize(&box->lock, "ipc_box_lock"); |
93 | waitq_initialize(&box->wq); |
||
955 | palkovsky | 94 | list_initialize(&box->connected_phones); |
95 | list_initialize(&box->calls); |
||
96 | list_initialize(&box->dispatched_calls); |
||
97 | list_initialize(&box->answers); |
||
1027 | palkovsky | 98 | box->task = TASK; |
955 | palkovsky | 99 | } |
100 | |||
1040 | palkovsky | 101 | /** Connect phone to answerbox */ |
102 | void ipc_phone_connect(phone_t *phone, answerbox_t *box) |
||
955 | palkovsky | 103 | { |
1084 | palkovsky | 104 | spinlock_lock(&phone->lock); |
105 | |||
1040 | palkovsky | 106 | ASSERT(!phone->callee); |
107 | phone->busy = 1; |
||
955 | palkovsky | 108 | phone->callee = box; |
965 | palkovsky | 109 | |
1040 | palkovsky | 110 | spinlock_lock(&box->lock); |
955 | palkovsky | 111 | list_append(&phone->list, &box->connected_phones); |
1040 | palkovsky | 112 | spinlock_unlock(&box->lock); |
1084 | palkovsky | 113 | |
114 | spinlock_unlock(&phone->lock); |
||
955 | palkovsky | 115 | } |
116 | |||
1040 | palkovsky | 117 | /** Initialize phone structure and connect phone to naswerbox |
118 | */ |
||
119 | void ipc_phone_init(phone_t *phone) |
||
120 | { |
||
121 | spinlock_initialize(&phone->lock, "phone_lock"); |
||
122 | phone->callee = NULL; |
||
123 | phone->busy = 0; |
||
124 | } |
||
125 | |||
959 | palkovsky | 126 | /** Helper function to facilitate synchronous calls */ |
127 | void ipc_call_sync(phone_t *phone, call_t *request) |
||
128 | { |
||
129 | answerbox_t sync_box; |
||
955 | palkovsky | 130 | |
959 | palkovsky | 131 | ipc_answerbox_init(&sync_box); |
132 | |||
133 | /* We will receive data on special box */ |
||
134 | request->callerbox = &sync_box; |
||
135 | |||
136 | ipc_call(phone, request); |
||
137 | ipc_wait_for_call(&sync_box, 0); |
||
138 | } |
||
139 | |||
1084 | palkovsky | 140 | /** Answer message that was not dispatched and is not entered in |
141 | * any queue |
||
142 | */ |
||
143 | static void _ipc_answer_free_call(call_t *call) |
||
144 | { |
||
145 | answerbox_t *callerbox = call->callerbox; |
||
146 | |||
147 | call->flags &= ~IPC_CALL_DISPATCHED; |
||
148 | call->flags |= IPC_CALL_ANSWERED; |
||
149 | |||
150 | spinlock_lock(&callerbox->lock); |
||
151 | list_append(&call->list, &callerbox->answers); |
||
152 | spinlock_unlock(&callerbox->lock); |
||
153 | waitq_wakeup(&callerbox->wq, 0); |
||
154 | } |
||
155 | |||
156 | /** Answer message, that is in callee queue |
||
157 | * |
||
158 | * @param box Answerbox that is answering the message |
||
159 | * @param call Modified request that is being sent back |
||
160 | */ |
||
161 | void ipc_answer(answerbox_t *box, call_t *call) |
||
162 | { |
||
163 | /* Remove from active box */ |
||
164 | spinlock_lock(&box->lock); |
||
165 | list_remove(&call->list); |
||
166 | spinlock_unlock(&box->lock); |
||
167 | /* Send back answer */ |
||
168 | _ipc_answer_free_call(call); |
||
169 | } |
||
170 | |||
1086 | palkovsky | 171 | /* Unsafe unchecking ipc_call */ |
172 | static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call) |
||
173 | { |
||
174 | atomic_inc(&phone->active_calls); |
||
175 | call->data.phone = phone; |
||
176 | |||
177 | spinlock_lock(&box->lock); |
||
178 | list_append(&call->list, &box->calls); |
||
179 | spinlock_unlock(&box->lock); |
||
180 | waitq_wakeup(&box->wq, 0); |
||
181 | } |
||
182 | |||
959 | palkovsky | 183 | /** Send a asynchronous request using phone to answerbox |
955 | palkovsky | 184 | * |
185 | * @param phone Phone connected to answerbox |
||
186 | * @param request Request to be sent |
||
187 | */ |
||
1040 | palkovsky | 188 | void ipc_call(phone_t *phone, call_t *call) |
955 | palkovsky | 189 | { |
1084 | palkovsky | 190 | answerbox_t *box; |
955 | palkovsky | 191 | |
1084 | palkovsky | 192 | spinlock_lock(&phone->lock); |
1086 | palkovsky | 193 | |
1084 | palkovsky | 194 | box = phone->callee; |
195 | if (!box) { |
||
196 | /* Trying to send over disconnected phone */ |
||
1086 | palkovsky | 197 | spinlock_unlock(&phone->lock); |
198 | |||
199 | call->data.phone = phone; |
||
1084 | palkovsky | 200 | IPC_SET_RETVAL(call->data, ENOENT); |
201 | _ipc_answer_free_call(call); |
||
202 | return; |
||
203 | } |
||
1086 | palkovsky | 204 | _ipc_call(phone, box, call); |
205 | |||
206 | spinlock_unlock(&phone->lock); |
||
207 | } |
||
955 | palkovsky | 208 | |
1086 | palkovsky | 209 | /** Disconnect phone from answerbox |
210 | * |
||
211 | * It is allowed to call disconnect on already disconnected phone |
||
212 | * |
||
213 | * @return 0 - phone disconnected, -1 - the phone was already disconnected |
||
214 | */ |
||
215 | int ipc_phone_hangup(phone_t *phone) |
||
216 | { |
||
217 | answerbox_t *box; |
||
218 | call_t *call; |
||
219 | |||
220 | spinlock_lock(&phone->lock); |
||
221 | box = phone->callee; |
||
222 | if (!box) { |
||
223 | spinlock_unlock(&phone->lock); |
||
224 | return -1; |
||
225 | } |
||
226 | |||
1040 | palkovsky | 227 | spinlock_lock(&box->lock); |
1086 | palkovsky | 228 | list_remove(&phone->list); |
229 | phone->callee = NULL; |
||
1040 | palkovsky | 230 | spinlock_unlock(&box->lock); |
1086 | palkovsky | 231 | |
232 | call = ipc_call_alloc(); |
||
233 | IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP); |
||
234 | call->flags |= IPC_CALL_DISCARD_ANSWER; |
||
235 | _ipc_call(phone, box, call); |
||
236 | |||
237 | phone->busy = 0; |
||
238 | |||
1084 | palkovsky | 239 | spinlock_unlock(&phone->lock); |
1086 | palkovsky | 240 | |
241 | return 0; |
||
955 | palkovsky | 242 | } |
243 | |||
1040 | palkovsky | 244 | /** Forwards call from one answerbox to a new one |
245 | * |
||
246 | * @param request Request to be forwarded |
||
247 | * @param newbox Target answerbox |
||
248 | * @param oldbox Old answerbox |
||
249 | */ |
||
1084 | palkovsky | 250 | void ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox) |
1040 | palkovsky | 251 | { |
252 | spinlock_lock(&oldbox->lock); |
||
1086 | palkovsky | 253 | atomic_dec(&call->data.phone->active_calls); |
1040 | palkovsky | 254 | list_remove(&call->list); |
255 | spinlock_unlock(&oldbox->lock); |
||
256 | |||
1084 | palkovsky | 257 | ipc_call(newphone, call); |
1040 | palkovsky | 258 | } |
259 | |||
955 | palkovsky | 260 | |
261 | /** Wait for phone call |
||
262 | * |
||
263 | * @return Recived message address |
||
264 | * - to distinguish between call and answer, look at call->flags |
||
265 | */ |
||
266 | call_t * ipc_wait_for_call(answerbox_t *box, int flags) |
||
267 | { |
||
268 | call_t *request; |
||
269 | |||
1086 | palkovsky | 270 | restart: |
271 | if (flags & IPC_WAIT_NONBLOCKING) { |
||
272 | if (waitq_sleep_timeout(&box->wq,0,1) == ESYNCH_WOULD_BLOCK) |
||
273 | return NULL; |
||
274 | } else |
||
275 | waitq_sleep(&box->wq); |
||
276 | |||
1040 | palkovsky | 277 | spinlock_lock(&box->lock); |
1086 | palkovsky | 278 | if (!list_empty(&box->answers)) { |
279 | /* Handle asynchronous answers */ |
||
280 | request = list_get_instance(box->answers.next, call_t, list); |
||
281 | list_remove(&request->list); |
||
282 | printf("%d %P\n", IPC_GET_METHOD(request->data), |
||
283 | request->data.phone); |
||
284 | atomic_dec(&request->data.phone->active_calls); |
||
285 | } else if (!list_empty(&box->calls)) { |
||
286 | /* Handle requests */ |
||
287 | request = list_get_instance(box->calls.next, call_t, list); |
||
288 | list_remove(&request->list); |
||
289 | /* Append request to dispatch queue */ |
||
290 | list_append(&request->list, &box->dispatched_calls); |
||
291 | request->flags |= IPC_CALL_DISPATCHED; |
||
292 | } else { |
||
293 | printf("WARNING: Spurious IPC wakeup.\n"); |
||
294 | spinlock_unlock(&box->lock); |
||
295 | goto restart; |
||
955 | palkovsky | 296 | } |
1040 | palkovsky | 297 | spinlock_unlock(&box->lock); |
955 | palkovsky | 298 | return request; |
299 | } |
||
300 | |||
301 | /** Initilize ipc subsystem */ |
||
302 | void ipc_init(void) |
||
303 | { |
||
304 | ipc_call_slab = slab_cache_create("ipc_call", |
||
305 | sizeof(call_t), |
||
306 | 0, |
||
307 | NULL, NULL, 0); |
||
308 | } |
||
1072 | palkovsky | 309 | |
310 | /** Cleans up all IPC communication of the given task |
||
311 | * |
||
312 | * |
||
313 | */ |
||
314 | void ipc_cleanup(task_t *task) |
||
315 | { |
||
316 | /* Cancel all calls in my dispatch queue */ |
||
317 | |||
318 | } |