Subversion Repositories HelenOS

Rev

Rev 3033 | Rev 3035 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

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