source: mainline/kernel/generic/src/ipc/ipc.c@ 52c60b6

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 52c60b6 was 170332d, checked in by Jakub Jermar <jermar@…>, 15 years ago

Disable interrupts when taking TASK→lock.

  • Property mode set to 100644
File size: 21.3 KB
RevLine 
[6d9c49a]1/*
[df4ed85]2 * Copyright (c) 2006 Ondrej Palkovsky
[6d9c49a]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
[cc73a8a1]29/** @addtogroup genericipc
[b45c443]30 * @{
31 */
32/** @file
33 */
34
[6d9c49a]35/* Lock ordering
36 *
[8b243f2]37 * First the answerbox, then the phone.
[6d9c49a]38 */
39
[ff48a15]40#include <synch/synch.h>
[2ba7810]41#include <synch/spinlock.h>
[ff48a15]42#include <synch/mutex.h>
[2ba7810]43#include <synch/waitq.h>
[bd5a663]44#include <synch/synch.h>
[6d9c49a]45#include <ipc/ipc.h>
[e028660]46#include <ipc/kbox.h>
[13a638d]47#include <ipc/event.h>
[6d9c49a]48#include <errno.h>
49#include <mm/slab.h>
50#include <arch.h>
51#include <proc/task.h>
52#include <memstr.h>
53#include <debug.h>
54#include <print.h>
[9a1b20c]55#include <console/console.h>
[6d9c49a]56#include <proc/thread.h>
[5626277]57#include <arch/interrupt.h>
[162f919]58#include <ipc/irq.h>
[6d9c49a]59
[8b243f2]60/** Open channel that is assigned automatically to new tasks */
[e74cb73]61answerbox_t *ipc_phone_0 = NULL;
[6d9c49a]62
63static slab_cache_t *ipc_call_slab;
[c70ce74]64static slab_cache_t *ipc_answerbox_slab;
[6d9c49a]65
[8b243f2]66/** Initialize a call structure.
67 *
68 * @param call Call structure to be initialized.
69 */
[ba81cab]70static void _ipc_call_init(call_t *call)
71{
[e32e092]72 memsetb(call, sizeof(*call), 0);
[ba81cab]73 call->callerbox = &TASK->answerbox;
74 call->sender = TASK;
[7918fce]75 call->buffer = NULL;
[ba81cab]76}
77
[8b243f2]78/** Allocate and initialize a call structure.
[6d9c49a]79 *
[8b243f2]80 * The call is initialized, so that the reply will be directed to
81 * TASK->answerbox.
82 *
83 * @param flags Parameters for slab_alloc (e.g FRAME_ATOMIC).
[5626277]84 *
[8b243f2]85 * @return If flags permit it, return NULL, or initialized kernel
86 * call structure.
[6d9c49a]87 */
[8b243f2]88call_t *ipc_call_alloc(int flags)
[6d9c49a]89{
90 call_t *call;
91
[5626277]92 call = slab_alloc(ipc_call_slab, flags);
[69eac4aa]93 if (call)
94 _ipc_call_init(call);
[6d9c49a]95
96 return call;
97}
98
[bd72c3e9]99/** Deallocate a call structure.
[8b243f2]100 *
101 * @param call Call structure to be freed.
102 */
[6d9c49a]103void ipc_call_free(call_t *call)
104{
[7918fce]105 /* Check to see if we have data in the IPC_M_DATA_SEND buffer. */
106 if (call->buffer)
107 free(call->buffer);
[6d9c49a]108 slab_free(ipc_call_slab, call);
109}
110
[8b243f2]111/** Initialize an answerbox structure.
112 *
113 * @param box Answerbox structure to be initialized.
[12ab886]114 * @param task Task to which the answerbox belongs.
[6d9c49a]115 */
[12ab886]116void ipc_answerbox_init(answerbox_t *box, task_t *task)
[6d9c49a]117{
[2ba7810]118 spinlock_initialize(&box->lock, "ipc_box_lock");
[5626277]119 spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
[2ba7810]120 waitq_initialize(&box->wq);
[33adc6ce]121 link_initialize(&box->sync_box_link);
[6d9c49a]122 list_initialize(&box->connected_phones);
123 list_initialize(&box->calls);
124 list_initialize(&box->dispatched_calls);
125 list_initialize(&box->answers);
[5626277]126 list_initialize(&box->irq_notifs);
[b14e35f2]127 list_initialize(&box->irq_head);
[12ab886]128 box->task = task;
[6d9c49a]129}
130
[8b243f2]131/** Connect a phone to an answerbox.
132 *
133 * @param phone Initialized phone structure.
134 * @param box Initialized answerbox structure.
135 */
[2ba7810]136void ipc_phone_connect(phone_t *phone, answerbox_t *box)
[6d9c49a]137{
[ff48a15]138 mutex_lock(&phone->lock);
[ba81cab]139
[eb3d379]140 phone->state = IPC_PHONE_CONNECTED;
[6d9c49a]141 phone->callee = box;
[e74cb73]142
[2ba7810]143 spinlock_lock(&box->lock);
[c4e4507]144 list_append(&phone->link, &box->connected_phones);
[2ba7810]145 spinlock_unlock(&box->lock);
[ba81cab]146
[ff48a15]147 mutex_unlock(&phone->lock);
[2ba7810]148}
149
[8b243f2]150/** Initialize a phone structure.
151 *
152 * @param phone Phone structure to be initialized.
[2ba7810]153 */
154void ipc_phone_init(phone_t *phone)
155{
[08a19ba]156 mutex_initialize(&phone->lock, MUTEX_PASSIVE);
[2ba7810]157 phone->callee = NULL;
[eb3d379]158 phone->state = IPC_PHONE_FREE;
[9f22213]159 atomic_set(&phone->active_calls, 0);
[6d9c49a]160}
161
[8b243f2]162/** Helper function to facilitate synchronous calls.
163 *
164 * @param phone Destination kernel phone structure.
165 * @param request Call structure with request.
[79872cd]166 *
167 * @return EOK on success or EINTR if the sleep was interrupted.
[8b243f2]168 */
[79872cd]169int ipc_call_sync(phone_t *phone, call_t *request)
[631ca4d]170{
[c70ce74]171 answerbox_t *sync_box;
[33adc6ce]172 ipl_t ipl;
[631ca4d]173
[c70ce74]174 sync_box = slab_alloc(ipc_answerbox_slab, 0);
175 ipc_answerbox_init(sync_box, TASK);
[631ca4d]176
[33adc6ce]177 /*
178 * Put the answerbox on the TASK's list of synchronous answerboxes so
179 * that it can be cleaned up if the call is interrupted.
180 */
181 ipl = interrupts_disable();
182 spinlock_lock(&TASK->lock);
183 list_append(&sync_box->sync_box_link, &TASK->sync_box_head);
184 spinlock_unlock(&TASK->lock);
185 interrupts_restore(ipl);
186
[8b243f2]187 /* We will receive data in a special box. */
[c70ce74]188 request->callerbox = sync_box;
[631ca4d]189
190 ipc_call(phone, request);
[c70ce74]191 if (!ipc_wait_for_call(sync_box, SYNCH_NO_TIMEOUT,
192 SYNCH_FLAGS_INTERRUPTIBLE)) {
[33adc6ce]193 /* The answerbox and the call will be freed by ipc_cleanup(). */
[79872cd]194 return EINTR;
[c70ce74]195 }
[33adc6ce]196
197 /*
198 * The answer arrived without interruption so we can remove the
199 * answerbox from the TASK's list of synchronous answerboxes.
200 */
201 (void) interrupts_disable();
202 spinlock_lock(&TASK->lock);
203 list_remove(&sync_box->sync_box_link);
204 spinlock_unlock(&TASK->lock);
205 interrupts_restore(ipl);
206
[c70ce74]207 slab_free(ipc_answerbox_slab, sync_box);
[79872cd]208 return EOK;
[631ca4d]209}
[6d9c49a]210
[8b243f2]211/** Answer a message which was not dispatched and is not listed in any queue.
212 *
213 * @param call Call structure to be answered.
[c713aa56]214 * @param selflocked If true, then TASK->answebox is locked.
[ba81cab]215 */
[c713aa56]216static void _ipc_answer_free_call(call_t *call, bool selflocked)
[ba81cab]217{
218 answerbox_t *callerbox = call->callerbox;
[c713aa56]219 bool do_lock = ((!selflocked) || callerbox != (&TASK->answerbox));
[170332d]220 ipl_t ipl;
[ba81cab]221
[95319bd]222 /* Count sent answer */
[170332d]223 ipl = interrupts_disable();
[a307beb]224 spinlock_lock(&TASK->lock);
225 TASK->ipc_info.answer_sent++;
226 spinlock_unlock(&TASK->lock);
[170332d]227 interrupts_restore(ipl);
[a307beb]228
[ba81cab]229 call->flags |= IPC_CALL_ANSWERED;
230
[74965d2]231 if (call->flags & IPC_CALL_FORWARDED) {
[27526e87]232 if (call->caller_phone) {
[74965d2]233 /* Demasquerade the caller phone. */
[27526e87]234 call->data.phone = call->caller_phone;
[74965d2]235 }
236 }
237
[c713aa56]238 if (do_lock)
239 spinlock_lock(&callerbox->lock);
[c4e4507]240 list_append(&call->link, &callerbox->answers);
[c713aa56]241 if (do_lock)
242 spinlock_unlock(&callerbox->lock);
[5c8ba05]243 waitq_wakeup(&callerbox->wq, WAKEUP_FIRST);
[ba81cab]244}
245
[8b243f2]246/** Answer a message which is in a callee queue.
[ba81cab]247 *
[8b243f2]248 * @param box Answerbox that is answering the message.
249 * @param call Modified request that is being sent back.
[ba81cab]250 */
251void ipc_answer(answerbox_t *box, call_t *call)
252{
253 /* Remove from active box */
254 spinlock_lock(&box->lock);
[c4e4507]255 list_remove(&call->link);
[ba81cab]256 spinlock_unlock(&box->lock);
257 /* Send back answer */
[c713aa56]258 _ipc_answer_free_call(call, false);
[ba81cab]259}
260
[8b243f2]261/** Simulate sending back a message.
[7c7aae16]262 *
263 * Most errors are better handled by forming a normal backward
264 * message and sending it as a normal answer.
[8b243f2]265 *
266 * @param phone Phone structure the call should appear to come from.
267 * @param call Call structure to be answered.
268 * @param err Return value to be used for the answer.
[7c7aae16]269 */
[7f1c620]270void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err)
[7c7aae16]271{
272 call->data.phone = phone;
273 atomic_inc(&phone->active_calls);
[eb3d379]274 IPC_SET_RETVAL(call->data, err);
[c713aa56]275 _ipc_answer_free_call(call, false);
[7c7aae16]276}
277
[8b243f2]278/** Unsafe unchecking version of ipc_call.
279 *
280 * @param phone Phone structure the call comes from.
281 * @param box Destination answerbox structure.
[7c5bcc0]282 * @param call Call structure with request.
[8b243f2]283 */
[fbcfd458]284static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
285{
[170332d]286 ipl_t ipl;
287
[95319bd]288 /* Count sent ipc call */
[170332d]289 ipl = interrupts_disable();
[a307beb]290 spinlock_lock(&TASK->lock);
291 TASK->ipc_info.call_sent++;
292 spinlock_unlock(&TASK->lock);
[170332d]293 interrupts_restore(ipl);
[a307beb]294
[8b243f2]295 if (!(call->flags & IPC_CALL_FORWARDED)) {
[9f22213]296 atomic_inc(&phone->active_calls);
297 call->data.phone = phone;
298 }
[fbcfd458]299
300 spinlock_lock(&box->lock);
[c4e4507]301 list_append(&call->link, &box->calls);
[fbcfd458]302 spinlock_unlock(&box->lock);
[5c8ba05]303 waitq_wakeup(&box->wq, WAKEUP_FIRST);
[fbcfd458]304}
305
[8b243f2]306/** Send an asynchronous request using a phone to an answerbox.
307 *
308 * @param phone Phone structure the call comes from and which is
309 * connected to the destination answerbox.
310 * @param call Call structure with request.
[6d9c49a]311 *
[8b243f2]312 * @return Return 0 on success, ENOENT on error.
[6d9c49a]313 */
[9f22213]314int ipc_call(phone_t *phone, call_t *call)
[6d9c49a]315{
[ba81cab]316 answerbox_t *box;
[6d9c49a]317
[ff48a15]318 mutex_lock(&phone->lock);
[eb3d379]319 if (phone->state != IPC_PHONE_CONNECTED) {
[ff48a15]320 mutex_unlock(&phone->lock);
[9f22213]321 if (call->flags & IPC_CALL_FORWARDED) {
322 IPC_SET_RETVAL(call->data, EFORWARD);
[c713aa56]323 _ipc_answer_free_call(call, false);
[eb3d379]324 } else {
325 if (phone->state == IPC_PHONE_HUNGUP)
[7c7aae16]326 ipc_backsend_err(phone, call, EHANGUP);
[9f22213]327 else
[7c7aae16]328 ipc_backsend_err(phone, call, ENOENT);
[9f22213]329 }
330 return ENOENT;
[ba81cab]331 }
[eb3d379]332 box = phone->callee;
[fbcfd458]333 _ipc_call(phone, box, call);
334
[ff48a15]335 mutex_unlock(&phone->lock);
[9f22213]336 return 0;
[fbcfd458]337}
338
[8b243f2]339/** Disconnect phone from answerbox.
[fbcfd458]340 *
[8b243f2]341 * This call leaves the phone in the HUNGUP state. The change to 'free' is done
[eb3d379]342 * lazily later.
[fbcfd458]343 *
[8b243f2]344 * @param phone Phone structure to be hung up.
[eb3d379]345 *
[8b243f2]346 * @return Return 0 if the phone is disconnected.
347 * Return -1 if the phone was already disconnected.
[fbcfd458]348 */
[d8f7362]349int ipc_phone_hangup(phone_t *phone)
[fbcfd458]350{
351 answerbox_t *box;
352 call_t *call;
353
[ff48a15]354 mutex_lock(&phone->lock);
[7918fce]355 if (phone->state == IPC_PHONE_FREE ||
356 phone->state == IPC_PHONE_HUNGUP ||
[8b243f2]357 phone->state == IPC_PHONE_CONNECTING) {
[ff48a15]358 mutex_unlock(&phone->lock);
[eb3d379]359 return -1;
[fbcfd458]360 }
[eb3d379]361 box = phone->callee;
362 if (phone->state != IPC_PHONE_SLAMMED) {
363 /* Remove myself from answerbox */
364 spinlock_lock(&box->lock);
[c4e4507]365 list_remove(&phone->link);
[eb3d379]366 spinlock_unlock(&box->lock);
[6d9c49a]367
[287e83f]368 call = ipc_call_alloc(0);
369 IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
370 call->flags |= IPC_CALL_DISCARD_ANSWER;
371 _ipc_call(phone, box, call);
[eb3d379]372 }
[fbcfd458]373
[eb3d379]374 phone->state = IPC_PHONE_HUNGUP;
[ff48a15]375 mutex_unlock(&phone->lock);
[fbcfd458]376
377 return 0;
[2ba7810]378}
379
[8b243f2]380/** Forwards call from one answerbox to another one.
[2ba7810]381 *
[8b243f2]382 * @param call Call structure to be redirected.
383 * @param newphone Phone structure to target answerbox.
384 * @param oldbox Old answerbox structure.
[d40a8ff]385 * @param mode Flags that specify mode of the forward operation.
[8b243f2]386 *
387 * @return Return 0 if forwarding succeeded or an error code if
388 * there was error.
[9f22213]389 *
[8b243f2]390 * The return value serves only as an information for the forwarder,
391 * the original caller is notified automatically with EFORWARD.
[2ba7810]392 */
[d40a8ff]393int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox, int mode)
[2ba7810]394{
[170332d]395 ipl_t ipl;
396
[95319bd]397 /* Count forwarded calls */
[170332d]398 ipl = interrupts_disable();
[a307beb]399 spinlock_lock(&TASK->lock);
400 TASK->ipc_info.forwarded++;
401 spinlock_unlock(&TASK->lock);
[170332d]402 interrupts_restore(ipl);
[a307beb]403
[2ba7810]404 spinlock_lock(&oldbox->lock);
[c4e4507]405 list_remove(&call->link);
[2ba7810]406 spinlock_unlock(&oldbox->lock);
407
[645d9ed2]408 if (mode & IPC_FF_ROUTE_FROM_ME) {
[27526e87]409 if (!call->caller_phone)
410 call->caller_phone = call->data.phone;
[9201f47]411 call->data.phone = newphone;
[645d9ed2]412 }
[9201f47]413
[9f22213]414 return ipc_call(newphone, call);
[6d9c49a]415}
416
417
[8b243f2]418/** Wait for a phone call.
[6d9c49a]419 *
[8b243f2]420 * @param box Answerbox expecting the call.
421 * @param usec Timeout in microseconds. See documentation for
422 * waitq_sleep_timeout() for decription of its special
423 * meaning.
424 * @param flags Select mode of sleep operation. See documentation for
425 * waitq_sleep_timeout() for description of its special
426 * meaning.
427 * @return Recived call structure or NULL.
428 *
429 * To distinguish between a call and an answer, have a look at call->flags.
[6d9c49a]430 */
[8b243f2]431call_t *ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags)
[6d9c49a]432{
433 call_t *request;
[5626277]434 ipl_t ipl;
[aa028db]435 uint64_t irq_cnt = 0;
436 uint64_t answer_cnt = 0;
437 uint64_t call_cnt = 0;
[bd5a663]438 int rc;
[6d9c49a]439
[bd5a663]440restart:
[116d1ef4]441 rc = waitq_sleep_timeout(&box->wq, usec, flags);
[bd5a663]442 if (SYNCH_FAILED(rc))
443 return NULL;
[fbcfd458]444
[2ba7810]445 spinlock_lock(&box->lock);
[5626277]446 if (!list_empty(&box->irq_notifs)) {
[95319bd]447 /* Count recieved IRQ notification */
[aa028db]448 irq_cnt++;
[a307beb]449
[5626277]450 ipl = interrupts_disable();
451 spinlock_lock(&box->irq_lock);
452
[c4e4507]453 request = list_get_instance(box->irq_notifs.next, call_t, link);
454 list_remove(&request->link);
[5626277]455
456 spinlock_unlock(&box->irq_lock);
457 interrupts_restore(ipl);
458 } else if (!list_empty(&box->answers)) {
[95319bd]459 /* Count recieved answer */
[aa028db]460 answer_cnt++;
[a307beb]461
[fbcfd458]462 /* Handle asynchronous answers */
[c4e4507]463 request = list_get_instance(box->answers.next, call_t, link);
464 list_remove(&request->link);
[74965d2]465 atomic_dec(&request->data.phone->active_calls);
[fbcfd458]466 } else if (!list_empty(&box->calls)) {
[95319bd]467 /* Count recieved call */
[aa028db]468 call_cnt++;
[a307beb]469
[fbcfd458]470 /* Handle requests */
[c4e4507]471 request = list_get_instance(box->calls.next, call_t, link);
472 list_remove(&request->link);
[fbcfd458]473 /* Append request to dispatch queue */
[c4e4507]474 list_append(&request->link, &box->dispatched_calls);
[fbcfd458]475 } else {
[874621f]476 /* This can happen regularly after ipc_cleanup */
[fbcfd458]477 spinlock_unlock(&box->lock);
478 goto restart;
[6d9c49a]479 }
[2ba7810]480 spinlock_unlock(&box->lock);
[aa028db]481
482 ipl = interrupts_disable();
483 spinlock_lock(&TASK->lock);
484 TASK->ipc_info.irq_notif_recieved += irq_cnt;
485 TASK->ipc_info.answer_recieved += answer_cnt;
486 TASK->ipc_info.call_recieved += call_cnt;
487 spinlock_unlock(&TASK->lock);
488 interrupts_restore(ipl);
489
[6d9c49a]490 return request;
491}
492
[8b243f2]493/** Answer all calls from list with EHANGUP answer.
494 *
495 * @param lst Head of the list to be cleaned up.
496 */
[9a1b20c]497void ipc_cleanup_call_list(link_t *lst)
[ca687ad]498{
499 call_t *call;
500
501 while (!list_empty(lst)) {
[c4e4507]502 call = list_get_instance(lst->next, call_t, link);
[a55d5f9f]503 if (call->buffer)
504 free(call->buffer);
[c4e4507]505 list_remove(&call->link);
[ca687ad]506
507 IPC_SET_RETVAL(call->data, EHANGUP);
[c713aa56]508 _ipc_answer_free_call(call, true);
[ca687ad]509 }
510}
511
[9a1b20c]512/** Disconnects all phones connected to an answerbox.
[4e49572]513 *
[9a1b20c]514 * @param box Answerbox to disconnect phones from.
515 * @param notify_box If true, the answerbox will get a hangup message for
516 * each disconnected phone.
[4e49572]517 */
[9a1b20c]518void ipc_answerbox_slam_phones(answerbox_t *box, bool notify_box)
[4e49572]519{
[ca687ad]520 phone_t *phone;
[31d8e10]521 DEADLOCK_PROBE_INIT(p_phonelck);
[9a1b20c]522 ipl_t ipl;
523 call_t *call;
[214c5a0]524
[9a1b20c]525 call = notify_box ? ipc_call_alloc(0) : NULL;
[5626277]526
[ca687ad]527 /* Disconnect all phones connected to our answerbox */
528restart_phones:
[9a1b20c]529 ipl = interrupts_disable();
530 spinlock_lock(&box->lock);
531 while (!list_empty(&box->connected_phones)) {
532 phone = list_get_instance(box->connected_phones.next,
[31d8e10]533 phone_t, link);
[ff48a15]534 if (SYNCH_FAILED(mutex_trylock(&phone->lock))) {
[9a1b20c]535 spinlock_unlock(&box->lock);
536 interrupts_restore(ipl);
[31d8e10]537 DEADLOCK_PROBE(p_phonelck, DEADLOCK_THRESHOLD);
[ca687ad]538 goto restart_phones;
539 }
540
541 /* Disconnect phone */
[eb3d379]542 ASSERT(phone->state == IPC_PHONE_CONNECTED);
[9a1b20c]543
[c4e4507]544 list_remove(&phone->link);
[9a1b20c]545 phone->state = IPC_PHONE_SLAMMED;
546
547 if (notify_box) {
548 mutex_unlock(&phone->lock);
549 spinlock_unlock(&box->lock);
550 interrupts_restore(ipl);
551
552 /*
553 * Send one message to the answerbox for each
554 * phone. Used to make sure the kbox thread
555 * wakes up after the last phone has been
556 * disconnected.
557 */
558 IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
559 call->flags |= IPC_CALL_DISCARD_ANSWER;
560 _ipc_call(phone, box, call);
561
562 /* Allocate another call in advance */
563 call = ipc_call_alloc(0);
564
565 /* Must start again */
566 goto restart_phones;
567 }
[ca687ad]568
[ff48a15]569 mutex_unlock(&phone->lock);
[ca687ad]570 }
[9f22213]571
[9a1b20c]572 spinlock_unlock(&box->lock);
573 interrupts_restore(ipl);
574
575 /* Free unused call */
[119c335]576 if (call)
577 ipc_call_free(call);
[9a1b20c]578}
579
580/** Cleans up all IPC communication of the current task.
581 *
582 * Note: ipc_hangup sets returning answerbox to TASK->answerbox, you
583 * have to change it as well if you want to cleanup other tasks than TASK.
584 */
585void ipc_cleanup(void)
586{
587 int i;
588 call_t *call;
[33adc6ce]589 ipl_t ipl;
[9a1b20c]590
591 /* Disconnect all our phones ('ipc_phone_hangup') */
592 for (i = 0; i < IPC_MAX_PHONES; i++)
593 ipc_phone_hangup(&TASK->phones[i]);
594
[05641a9e]595 /* Unsubscribe from any event notifications. */
596 event_cleanup_answerbox(&TASK->answerbox);
597
[9a1b20c]598 /* Disconnect all connected irqs */
599 ipc_irq_cleanup(&TASK->answerbox);
600
601 /* Disconnect all phones connected to our regular answerbox */
602 ipc_answerbox_slam_phones(&TASK->answerbox, false);
603
604#ifdef CONFIG_UDEBUG
605 /* Clean up kbox thread and communications */
606 ipc_kbox_cleanup();
607#endif
608
[9f22213]609 /* Answer all messages in 'calls' and 'dispatched_calls' queues */
[9a1b20c]610 spinlock_lock(&TASK->answerbox.lock);
[214c5a0]611 ipc_cleanup_call_list(&TASK->answerbox.dispatched_calls);
612 ipc_cleanup_call_list(&TASK->answerbox.calls);
613 spinlock_unlock(&TASK->answerbox.lock);
[4e49572]614
[33adc6ce]615 /* Wait for all answers to interrupted synchronous calls to arrive */
616 ipl = interrupts_disable();
617 while (!list_empty(&TASK->sync_box_head)) {
618 answerbox_t *box = list_get_instance(TASK->sync_box_head.next,
619 answerbox_t, sync_box_link);
620
621 list_remove(&box->sync_box_link);
622 call = ipc_wait_for_call(box, SYNCH_NO_TIMEOUT,
623 SYNCH_FLAGS_NONE);
624 ipc_call_free(call);
625 slab_free(ipc_answerbox_slab, box);
626 }
627 interrupts_restore(ipl);
628
629 /* Wait for all answers to asynchronous calls to arrive */
[eb3d379]630 while (1) {
631 /* Go through all phones, until all are FREE... */
632 /* Locking not needed, no one else should modify
633 * it, when we are in cleanup */
[8b243f2]634 for (i = 0; i < IPC_MAX_PHONES; i++) {
635 if (TASK->phones[i].state == IPC_PHONE_HUNGUP &&
[e701eb1]636 atomic_get(&TASK->phones[i].active_calls) == 0) {
[214c5a0]637 TASK->phones[i].state = IPC_PHONE_FREE;
[e701eb1]638 TASK->phones[i].callee = NULL;
639 }
[214c5a0]640
[d8f7362]641 /* Just for sure, we might have had some
642 * IPC_PHONE_CONNECTING phones */
[214c5a0]643 if (TASK->phones[i].state == IPC_PHONE_CONNECTED)
[d8f7362]644 ipc_phone_hangup(&TASK->phones[i]);
645 /* If the hangup succeeded, it has sent a HANGUP
646 * message, the IPC is now in HUNGUP state, we
647 * wait for the reply to come */
[214c5a0]648
649 if (TASK->phones[i].state != IPC_PHONE_FREE)
[eb3d379]650 break;
651 }
652 /* Voila, got into cleanup */
653 if (i == IPC_MAX_PHONES)
654 break;
655
[8b243f2]656 call = ipc_wait_for_call(&TASK->answerbox, SYNCH_NO_TIMEOUT,
657 SYNCH_FLAGS_NONE);
658 ASSERT((call->flags & IPC_CALL_ANSWERED) ||
659 (call->flags & IPC_CALL_NOTIF));
[ca687ad]660
[119c335]661 /*
662 * Record the receipt of this call in the current task's counter
663 * of active calls. IPC_M_PHONE_HUNGUP calls do not contribute
664 * to this counter so do not record answers to them either.
665 */
[4e5aa02]666 if (!(call->flags & IPC_CALL_DISCARD_ANSWER))
667 atomic_dec(&TASK->active_calls);
[ca687ad]668 ipc_call_free(call);
669 }
[4e49572]670}
[5626277]671
672
[2b017ba]673/** Initilize IPC subsystem */
[5626277]674void ipc_init(void)
675{
[8b243f2]676 ipc_call_slab = slab_cache_create("ipc_call", sizeof(call_t), 0, NULL,
677 NULL, 0);
[c70ce74]678 ipc_answerbox_slab = slab_cache_create("ipc_answerbox",
679 sizeof(answerbox_t), 0, NULL, NULL, 0);
[5626277]680}
681
[c4e4507]682
[8b243f2]683/** List answerbox contents.
684 *
685 * @param taskid Task ID.
686 */
[c4e4507]687void ipc_print_task(task_id_t taskid)
688{
689 task_t *task;
690 int i;
691 call_t *call;
692 link_t *tmp;
[170332d]693 ipl_t ipl;
[c4e4507]694
[170332d]695 ipl = interrupts_disable();
[c4e4507]696 spinlock_lock(&tasks_lock);
697 task = task_find_by_id(taskid);
698 if (task)
699 spinlock_lock(&task->lock);
700 spinlock_unlock(&tasks_lock);
[170332d]701 if (!task) {
702 interrupts_restore(ipl);
[c4e4507]703 return;
[170332d]704 }
[c4e4507]705
706 /* Print opened phones & details */
707 printf("PHONE:\n");
[8b243f2]708 for (i = 0; i < IPC_MAX_PHONES; i++) {
[ff48a15]709 if (SYNCH_FAILED(mutex_trylock(&task->phones[i].lock))) {
710 printf("%d: mutex busy\n", i);
711 continue;
712 }
[c4e4507]713 if (task->phones[i].state != IPC_PHONE_FREE) {
[8b243f2]714 printf("%d: ", i);
[c4e4507]715 switch (task->phones[i].state) {
716 case IPC_PHONE_CONNECTING:
717 printf("connecting ");
718 break;
719 case IPC_PHONE_CONNECTED:
[fbf7b4c]720 printf("connected to: %p ",
[c4e4507]721 task->phones[i].callee);
722 break;
723 case IPC_PHONE_SLAMMED:
[fbf7b4c]724 printf("slammed by: %p ",
[c4e4507]725 task->phones[i].callee);
726 break;
727 case IPC_PHONE_HUNGUP:
[fbf7b4c]728 printf("hung up - was: %p ",
[c4e4507]729 task->phones[i].callee);
730 break;
731 default:
732 break;
733 }
[9fe962d6]734 printf("active: %ld\n",
[bd72c3e9]735 atomic_get(&task->phones[i].active_calls));
[c4e4507]736 }
[ff48a15]737 mutex_unlock(&task->phones[i].lock);
[c4e4507]738 }
739
740
741 /* Print answerbox - calls */
742 spinlock_lock(&task->answerbox.lock);
743 printf("ABOX - CALLS:\n");
[bd72c3e9]744 for (tmp = task->answerbox.calls.next; tmp != &task->answerbox.calls;
[78d0da8]745 tmp = tmp->next) {
[c4e4507]746 call = list_get_instance(tmp, call_t, link);
[9fe962d6]747 printf("Callid: %p Srctask:%" PRIu64 " M:%" PRIun
[e40e3007]748 " A1:%" PRIun " A2:%" PRIun " A3:%" PRIun
749 " A4:%" PRIun " A5:%" PRIun " Flags:%x\n", call,
750 call->sender->taskid,
[bd72c3e9]751 IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
752 IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data),
[38c706cc]753 IPC_GET_ARG4(call->data), IPC_GET_ARG5(call->data),
[bd72c3e9]754 call->flags);
[c4e4507]755 }
756 /* Print answerbox - calls */
757 printf("ABOX - DISPATCHED CALLS:\n");
[9fe962d6]758 for (tmp = task->answerbox.dispatched_calls.next;
[78d0da8]759 tmp != &task->answerbox.dispatched_calls;
760 tmp = tmp->next) {
[c4e4507]761 call = list_get_instance(tmp, call_t, link);
[9fe962d6]762 printf("Callid: %p Srctask:%" PRIu64 " M:%" PRIun
[e40e3007]763 " A1:%" PRIun " A2:%" PRIun " A3:%" PRIun
764 " A4:%" PRIun " A5:%" PRIun " Flags:%x\n", call,
765 call->sender->taskid,
[bd72c3e9]766 IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
767 IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data),
[38c706cc]768 IPC_GET_ARG4(call->data), IPC_GET_ARG5(call->data),
[bd72c3e9]769 call->flags);
[c4e4507]770 }
771 /* Print answerbox - calls */
772 printf("ABOX - ANSWERS:\n");
[e40e3007]773 for (tmp = task->answerbox.answers.next;
774 tmp != &task->answerbox.answers;
[78d0da8]775 tmp = tmp->next) {
[c4e4507]776 call = list_get_instance(tmp, call_t, link);
[9fe962d6]777 printf("Callid:%p M:%" PRIun " A1:%" PRIun " A2:%" PRIun
[e40e3007]778 " A3:%" PRIun " A4:%" PRIun " A5:%" PRIun " Flags:%x\n",
[38c706cc]779 call, IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
[bd72c3e9]780 IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data),
[38c706cc]781 IPC_GET_ARG4(call->data), IPC_GET_ARG5(call->data),
[bd72c3e9]782 call->flags);
[c4e4507]783 }
784
785 spinlock_unlock(&task->answerbox.lock);
786 spinlock_unlock(&task->lock);
[170332d]787 interrupts_restore(ipl);
[c4e4507]788}
[b45c443]789
[cc73a8a1]790/** @}
[b45c443]791 */
Note: See TracBrowser for help on using the repository browser.