Subversion Repositories HelenOS

Rev

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