WebSVN – HelenOS – Diff – /branches/tracing/kernel/generic/src/ipc/ipc.c


/*
 * Copyright (c) 2006 Ondrej Palkovsky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericipc
 * @{
 */
/** @file
 */
 
/* Lock ordering
 *
 * First the answerbox, then the phone.
 */
 
#include <synch/synch.h>
#include <synch/spinlock.h>
#include <synch/mutex.h>
#include <synch/waitq.h>
#include <synch/synch.h>
#include <ipc/ipc.h>
#include <errno.h>
#include <mm/slab.h>
#include <arch.h>
#include <proc/task.h>
#include <memstr.h>
#include <debug.h>
 
#include <print.h>
#include <console/console.h>
#include <proc/thread.h>
#include <arch/interrupt.h>
#include <ipc/irq.h>
 
/** Open channel that is assigned automatically to new tasks */
answerbox_t *ipc_phone_0 = NULL;
 
static slab_cache_t *ipc_call_slab;
 
/** Initialize a call structure.
 *
 * @param call      Call structure to be initialized.
 */
static void _ipc_call_init(call_t *call)
{
    memsetb(call, sizeof(*call), 0);
    call->callerbox = &TASK->answerbox;
    call->sender = TASK;
    call->buffer = NULL;
}
 
/** Allocate and initialize a call structure.
 *
 * The call is initialized, so that the reply will be directed to
 * TASK->answerbox.
 *
 * @param flags     Parameters for slab_alloc (e.g FRAME_ATOMIC).
 *
 * @return      If flags permit it, return NULL, or initialized kernel
 *          call structure.
 */
call_t *ipc_call_alloc(int flags)
{
    call_t *call;
 
    call = slab_alloc(ipc_call_slab, flags);
    if (call)
        _ipc_call_init(call);
 
    return call;
}
 
/** Initialize a statically allocated call structure.
 *
 * @param call      Statically allocated kernel call structure to be
 *          initialized.
 */
void ipc_call_static_init(call_t *call)
{
    _ipc_call_init(call);
    call->flags |= IPC_CALL_STATIC_ALLOC;
}
 
/** Deallocate a call structure.
 *
 * @param call      Call structure to be freed.
 */
void ipc_call_free(call_t *call)
{
    ASSERT(!(call->flags & IPC_CALL_STATIC_ALLOC));
    /* Check to see if we have data in the IPC_M_DATA_SEND buffer. */
    if (call->buffer)
        free(call->buffer);
    slab_free(ipc_call_slab, call);
}
 
/** Initialize an answerbox structure.
 *
 * @param box       Answerbox structure to be initialized.
 * @param task      Task to which the answerbox belongs.
 */
void ipc_answerbox_init(answerbox_t *box, task_t *task)
{
    spinlock_initialize(&box->lock, "ipc_box_lock");
    spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
    waitq_initialize(&box->wq);
    list_initialize(&box->connected_phones);
    list_initialize(&box->calls);
    list_initialize(&box->dispatched_calls);
    list_initialize(&box->answers);
    list_initialize(&box->irq_notifs);
    list_initialize(&box->irq_head);
    box->task = task;
}
 
/** Connect a phone to an answerbox.
 *
 * @param phone     Initialized phone structure.
 * @param box       Initialized answerbox structure.
 */
void ipc_phone_connect(phone_t *phone, answerbox_t *box)
{
    mutex_lock(&phone->lock);
 
    phone->state = IPC_PHONE_CONNECTED;
    phone->callee = box;
 
    spinlock_lock(&box->lock);
    list_append(&phone->link, &box->connected_phones);
    spinlock_unlock(&box->lock);
 
    mutex_unlock(&phone->lock);
}
 
/** Initialize a phone structure.
 *
 * @param phone     Phone structure to be initialized.
 */
void ipc_phone_init(phone_t *phone)
{
    mutex_initialize(&phone->lock, MUTEX_PASSIVE);
    phone->callee = NULL;
    phone->state = IPC_PHONE_FREE;
    atomic_set(&phone->active_calls, 0);
}
 
/** Helper function to facilitate synchronous calls.
 *
 * @param phone     Destination kernel phone structure.
 * @param request   Call structure with request.
 *
 * @return      EOK on success or EINTR if the sleep was interrupted.
 */
int ipc_call_sync(phone_t *phone, call_t *request)
{
    answerbox_t sync_box;
 
    ipc_answerbox_init(&sync_box, TASK);
 
    /* We will receive data in a special box. */
    request->callerbox = &sync_box;
 
    ipc_call(phone, request);
    if (!ipc_wait_for_call(&sync_box, SYNCH_NO_TIMEOUT,
        SYNCH_FLAGS_INTERRUPTIBLE))
        return EINTR;
    return EOK;
}
 
/** Answer a message which was not dispatched and is not listed in any queue.
 *
 * @param call      Call structure to be answered.
 */
static void _ipc_answer_free_call(call_t *call)
{
    answerbox_t *callerbox = call->callerbox;
 
    call->flags |= IPC_CALL_ANSWERED;
 
    if (call->flags & IPC_CALL_FORWARDED) {
        if (call->caller_phone) {
            /* Demasquerade the caller phone. */
            call->data.phone = call->caller_phone;
        }
    }
 
    spinlock_lock(&callerbox->lock);
    list_append(&call->link, &callerbox->answers);
    spinlock_unlock(&callerbox->lock);
    waitq_wakeup(&callerbox->wq, WAKEUP_FIRST);
}
 
/** Answer a message which is in a callee queue.
 *
 * @param box       Answerbox that is answering the message.
 * @param call      Modified request that is being sent back.
 */
void ipc_answer(answerbox_t *box, call_t *call)
{
    /* Remove from active box */
    spinlock_lock(&box->lock);
    list_remove(&call->link);
    spinlock_unlock(&box->lock);
    /* Send back answer */
    _ipc_answer_free_call(call);
}
 
/** Simulate sending back a message.
 *
 * Most errors are better handled by forming a normal backward
 * message and sending it as a normal answer.
 *
 * @param phone     Phone structure the call should appear to come from.
 * @param call      Call structure to be answered.
 * @param err       Return value to be used for the answer.
 */
void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err)
{
    call->data.phone = phone;
    atomic_inc(&phone->active_calls);
    IPC_SET_RETVAL(call->data, err);
    _ipc_answer_free_call(call);
}
 
/** Unsafe unchecking version of ipc_call.
 *
 * @param phone     Phone structure the call comes from.
 * @param box       Destination answerbox structure.
 * @param call      Call structure with request.
 */
static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
{
    if (!(call->flags & IPC_CALL_FORWARDED)) {
        atomic_inc(&phone->active_calls);
        call->data.phone = phone;
    }
 
    spinlock_lock(&box->lock);
    list_append(&call->link, &box->calls);
    spinlock_unlock(&box->lock);
    waitq_wakeup(&box->wq, WAKEUP_FIRST);
}
 
/** Send an asynchronous request using a phone to an answerbox.
 *
 * @param phone     Phone structure the call comes from and which is
 *          connected to the destination answerbox.
 * @param call      Call structure with request.
 *
 * @return      Return 0 on success, ENOENT on error.
 */
int ipc_call(phone_t *phone, call_t *call)
{
    answerbox_t *box;
 
    mutex_lock(&phone->lock);
    if (phone->state != IPC_PHONE_CONNECTED) {
        mutex_unlock(&phone->lock);
        if (call->flags & IPC_CALL_FORWARDED) {
            IPC_SET_RETVAL(call->data, EFORWARD);
            _ipc_answer_free_call(call);
        } else {
            if (phone->state == IPC_PHONE_HUNGUP)
                ipc_backsend_err(phone, call, EHANGUP);
            else
                ipc_backsend_err(phone, call, ENOENT);
        }
        return ENOENT;
    }
    box = phone->callee;
    _ipc_call(phone, box, call);
   
    mutex_unlock(&phone->lock);
    return 0;
}
 
/** Disconnect phone from answerbox.
 *
 * This call leaves the phone in the HUNGUP state. The change to 'free' is done
 * lazily later.
 *
 * @param phone     Phone structure to be hung up.
 *              
 * @return      Return 0 if the phone is disconnected.
 *          Return -1 if the phone was already disconnected.
 */
int ipc_phone_hangup(phone_t *phone)
{
    answerbox_t *box;
    call_t *call;
   
    mutex_lock(&phone->lock);
    if (phone->state == IPC_PHONE_FREE ||
        phone->state == IPC_PHONE_HUNGUP ||
        phone->state == IPC_PHONE_CONNECTING) {
        mutex_unlock(&phone->lock);
        return -1;
    }
    box = phone->callee;
    if (phone->state != IPC_PHONE_SLAMMED) {
        /* Remove myself from answerbox */
        spinlock_lock(&box->lock);
        list_remove(&phone->link);
        spinlock_unlock(&box->lock);
 
        if (phone->state != IPC_PHONE_SLAMMED) {
            call = ipc_call_alloc(0);
            IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
            call->flags |= IPC_CALL_DISCARD_ANSWER;
            _ipc_call(phone, box, call);
        }
    }
 
    phone->state = IPC_PHONE_HUNGUP;
    mutex_unlock(&phone->lock);
 
    return 0;
}
 
/** Forwards call from one answerbox to another one.
 *
 * @param call      Call structure to be redirected.
 * @param newphone  Phone structure to target answerbox.
 * @param oldbox    Old answerbox structure.
 * @param mode      Flags that specify mode of the forward operation.
 *
 * @return      Return 0 if forwarding succeeded or an error code if
 *          there was error.
 *
 * The return value serves only as an information for the forwarder,
 * the original caller is notified automatically with EFORWARD.
 */
int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox, int mode)
{
    spinlock_lock(&oldbox->lock);
    list_remove(&call->link);
    spinlock_unlock(&oldbox->lock);
 
    if (mode & IPC_FF_ROUTE_FROM_ME) {
        if (!call->caller_phone)
            call->caller_phone = call->data.phone;
        call->data.phone = newphone;
    }
 
    return ipc_call(newphone, call);
}
 
 
/** Wait for a phone call.
 *
 * @param box       Answerbox expecting the call.
 * @param usec      Timeout in microseconds. See documentation for
 *          waitq_sleep_timeout() for decription of its special
 *          meaning.
 * @param flags     Select mode of sleep operation. See documentation for
 *          waitq_sleep_timeout() for description of its special
 *          meaning.
 * @return      Recived call structure or NULL.
 *
 * To distinguish between a call and an answer, have a look at call->flags.
 */
call_t *ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags)
{
    call_t *request;
    ipl_t ipl;
    int rc;
 
restart:
    rc = waitq_sleep_timeout(&box->wq, usec, flags);
    if (SYNCH_FAILED(rc))
        return NULL;
   
    spinlock_lock(&box->lock);
    if (!list_empty(&box->irq_notifs)) {
        ipl = interrupts_disable();
        spinlock_lock(&box->irq_lock);
 
        request = list_get_instance(box->irq_notifs.next, call_t, link);
        list_remove(&request->link);
 
        spinlock_unlock(&box->irq_lock);
        interrupts_restore(ipl);
    } else if (!list_empty(&box->answers)) {
        /* Handle asynchronous answers */
        request = list_get_instance(box->answers.next, call_t, link);
        list_remove(&request->link);
        atomic_dec(&request->data.phone->active_calls);
    } else if (!list_empty(&box->calls)) {
        /* Handle requests */
        request = list_get_instance(box->calls.next, call_t, link);
        list_remove(&request->link);
        /* Append request to dispatch queue */
        list_append(&request->link, &box->dispatched_calls);
    } else {
        /* This can happen regularly after ipc_cleanup */
        spinlock_unlock(&box->lock);
        goto restart;
    }
    spinlock_unlock(&box->lock);
    return request;
}
 
/** Answer all calls from list with EHANGUP answer.
 *
 * @param lst       Head of the list to be cleaned up.
 */
static void ipc_cleanup_call_list(link_t *lst)
{
    call_t *call;
 
    while (!list_empty(lst)) {
        call = list_get_instance(lst->next, call_t, link);
        if (call->buffer)
            free(call->buffer);
        list_remove(&call->link);
 
        IPC_SET_RETVAL(call->data, EHANGUP);
        _ipc_answer_free_call(call);
    }
}
 
/** Disconnects all phones connected to an answerbox.
 *
 * @param box       Answerbox to disconnect phones from.
 * @param notify_box    If true, the answerbox will get a hangup message for
 *          each disconnected phone.
 */
static void ipc_answerbox_slam_phones(answerbox_t *box, bool notify_box)
{
    phone_t *phone;
    DEADLOCK_PROBE_INIT(p_phonelck);
    ipl_t ipl;
    call_t *call;
 
    call = notify_box ? ipc_call_alloc(0) : NULL;
 
    /* Disconnect all phones connected to our answerbox */
restart_phones:
    ipl = interrupts_disable();
    spinlock_lock(&box->lock);
    while (!list_empty(&box->connected_phones)) {
        phone = list_get_instance(box->connected_phones.next,
            phone_t, link);
        if (SYNCH_FAILED(mutex_trylock(&phone->lock))) {
            spinlock_unlock(&box->lock);
            interrupts_restore(ipl);
            DEADLOCK_PROBE(p_phonelck, DEADLOCK_THRESHOLD);
            goto restart_phones;
        }
       
        /* Disconnect phone */
        ASSERT(phone->state == IPC_PHONE_CONNECTED);
 
        list_remove(&phone->link);
        phone->state = IPC_PHONE_SLAMMED;
 
        if (notify_box) {
            mutex_unlock(&phone->lock);
            spinlock_unlock(&box->lock);
            interrupts_restore(ipl);
 
            /*
             * Send one message to the answerbox for each
             * phone. Used to make sure the kbox thread
             * wakes up after the last phone has been
             * disconnected.
             */
            IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
            call->flags |= IPC_CALL_DISCARD_ANSWER;
            _ipc_call(phone, box, call);
 
            /* Allocate another call in advance */
            call = ipc_call_alloc(0);
 
            /* Must start again */
            goto restart_phones;
        }
 
        mutex_unlock(&phone->lock);
    }
 
    spinlock_unlock(&box->lock);
    interrupts_restore(ipl);
 
    /* Free unused call */
    if (call) ipc_call_free(call);
}
 
#ifdef CONFIG_UDEBUG
 
static void ipc_kbox_cleanup()
{
    bool have_kb_thread;
 
    /* Only hold kb_cleanup_lock while setting kb_finished - this is enough */
    mutex_lock(&TASK->kb_cleanup_lock);
    TASK->kb_finished = true;
    mutex_unlock(&TASK->kb_cleanup_lock);
 
    have_kb_thread = (TASK->kb_thread != NULL);
 
    /* From now on nobody will try to connect phones or attach kbox threads */
 
    /*
     * Disconnect all phones connected to our kbox. Passing true for
     * notify_box causes a HANGUP message to be inserted for each
     * disconnected phone. This ensures the kbox thread is going to
     * wake up and terminate.
     */
    ipc_answerbox_slam_phones(&TASK->kernel_box, have_kb_thread);
   
    if (have_kb_thread) {
        printf("join kb_thread..\n");
        thread_join(TASK->kb_thread);
        thread_detach(TASK->kb_thread);
        printf("join done\n");
        TASK->kb_thread = NULL;
    }
 
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
    spinlock_lock(&TASK->kernel_box.lock);
    ipc_cleanup_call_list(&TASK->kernel_box.dispatched_calls);
    ipc_cleanup_call_list(&TASK->kernel_box.calls);
    spinlock_unlock(&TASK->kernel_box.lock);
}
 
#endif
 
/** Cleans up all IPC communication of the current task.
 *
 * Note: ipc_hangup sets returning answerbox to TASK->answerbox, you
 * have to change it as well if you want to cleanup other tasks than TASK.
 */
void ipc_cleanup(void)
{
    int i;
    call_t *call;
 
    /* Disconnect all our phones ('ipc_phone_hangup') */
    for (i = 0; i < IPC_MAX_PHONES; i++)
        ipc_phone_hangup(&TASK->phones[i]);
 
    /* Disconnect all connected irqs */
    ipc_irq_cleanup(&TASK->answerbox);
 
    /* Disconnect all phones connected to our regular answerbox */
    ipc_answerbox_slam_phones(&TASK->answerbox, false);
 
#ifdef CONFIG_UDEBUG
    /* Clean up kbox thread and communications */
    ipc_kbox_cleanup();
#endif
 
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
    spinlock_lock(&TASK->answerbox.lock);
    ipc_cleanup_call_list(&TASK->answerbox.dispatched_calls);
    ipc_cleanup_call_list(&TASK->answerbox.calls);
    spinlock_unlock(&TASK->answerbox.lock);
   
    /* Wait for all async answers to arrive */
    while (1) {
        /* Go through all phones, until all are FREE... */
        /* Locking not needed, no one else should modify
         * it, when we are in cleanup */
        for (i = 0; i < IPC_MAX_PHONES; i++) {
            if (TASK->phones[i].state == IPC_PHONE_HUNGUP &&
                atomic_get(&TASK->phones[i].active_calls) == 0)
                TASK->phones[i].state = IPC_PHONE_FREE;
           
            /* Just for sure, we might have had some
             * IPC_PHONE_CONNECTING phones */
            if (TASK->phones[i].state == IPC_PHONE_CONNECTED)
                ipc_phone_hangup(&TASK->phones[i]);
            /* If the hangup succeeded, it has sent a HANGUP
             * message, the IPC is now in HUNGUP state, we
             * wait for the reply to come */
           
            if (TASK->phones[i].state != IPC_PHONE_FREE)
                break;
        }
        /* Voila, got into cleanup */
        if (i == IPC_MAX_PHONES)
            break;
       
        call = ipc_wait_for_call(&TASK->answerbox, SYNCH_NO_TIMEOUT,
            SYNCH_FLAGS_NONE);
        ASSERT((call->flags & IPC_CALL_ANSWERED) ||
            (call->flags & IPC_CALL_NOTIF));
        ASSERT(!(call->flags & IPC_CALL_STATIC_ALLOC));
       
        atomic_dec(&TASK->active_calls);
        ipc_call_free(call);
    }
}
 
 
/** Initilize IPC subsystem */
void ipc_init(void)
{
    ipc_call_slab = slab_cache_create("ipc_call", sizeof(call_t), 0, NULL,
        NULL, 0);
}
 
 
/** List answerbox contents.
 *
 * @param taskid    Task ID.
 */
void ipc_print_task(task_id_t taskid)
{
    task_t *task;
    int i;
    call_t *call;
    link_t *tmp;
   
    spinlock_lock(&tasks_lock);
    task = task_find_by_id(taskid);
    if (task)
        spinlock_lock(&task->lock);
    spinlock_unlock(&tasks_lock);
    if (!task)
        return;
 
    /* Print opened phones & details */
    printf("PHONE:\n");
    for (i = 0; i < IPC_MAX_PHONES; i++) {
        if (SYNCH_FAILED(mutex_trylock(&task->phones[i].lock))) {
            printf("%d: mutex busy\n", i);
            continue;
        }
        if (task->phones[i].state != IPC_PHONE_FREE) {
            printf("%d: ", i);
            switch (task->phones[i].state) {
            case IPC_PHONE_CONNECTING:
                printf("connecting ");
                break;
            case IPC_PHONE_CONNECTED:
                printf("connected to: %p ",
                       task->phones[i].callee);
                break;
            case IPC_PHONE_SLAMMED:
                printf("slammed by: %p ",
                       task->phones[i].callee);
                break;
            case IPC_PHONE_HUNGUP:
                printf("hung up - was: %p ",
                       task->phones[i].callee);
                break;
            default:
                break;
            }
            printf("active: %ld\n",
                atomic_get(&task->phones[i].active_calls));
        }
        mutex_unlock(&task->phones[i].lock);
    }
 
 
    /* Print answerbox - calls */
    spinlock_lock(&task->answerbox.lock);
    printf("ABOX - CALLS:\n");
    for (tmp = task->answerbox.calls.next; tmp != &task->answerbox.calls;
        tmp = tmp->next) {
        call = list_get_instance(tmp, call_t, link);
        printf("Callid: %p Srctask:%" PRIu64 " M:%" PRIun
            " A1:%" PRIun " A2:%" PRIun " A3:%" PRIun
            " A4:%" PRIun " A5:%" PRIun " Flags:%x\n", call,
            call->sender->taskid,
            IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
            IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data),
            IPC_GET_ARG4(call->data), IPC_GET_ARG5(call->data),
            call->flags);
    }
    /* Print answerbox - calls */
    printf("ABOX - DISPATCHED CALLS:\n");
    for (tmp = task->answerbox.dispatched_calls.next;
        tmp != &task->answerbox.dispatched_calls;
        tmp = tmp->next) {
        call = list_get_instance(tmp, call_t, link);
        printf("Callid: %p Srctask:%" PRIu64 " M:%" PRIun
            " A1:%" PRIun " A2:%" PRIun " A3:%" PRIun
            " A4:%" PRIun " A5:%" PRIun " Flags:%x\n", call,
            call->sender->taskid,
            IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
            IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data),
            IPC_GET_ARG4(call->data), IPC_GET_ARG5(call->data),
            call->flags);
    }
    /* Print answerbox - calls */
    printf("ABOX - ANSWERS:\n");
    for (tmp = task->answerbox.answers.next;
        tmp != &task->answerbox.answers;
        tmp = tmp->next) {
        call = list_get_instance(tmp, call_t, link);
        printf("Callid:%p M:%" PRIun " A1:%" PRIun " A2:%" PRIun
            " A3:%" PRIun " A4:%" PRIun " A5:%" PRIun " Flags:%x\n",
            call, IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
            IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data),
            IPC_GET_ARG4(call->data), IPC_GET_ARG5(call->data),
            call->flags);
    }
 
    spinlock_unlock(&task->answerbox.lock);
    spinlock_unlock(&task->lock);
}
 
#ifdef CONFIG_UDEBUG
 
#include <ipc/ipcrsc.h>
#include <print.h>
#include <udebug/udebug_ipc.h>
 
static void kbox_thread_proc(void *arg)
{
    call_t *call;
    int method;
    bool done;
    ipl_t ipl;
 
    (void)arg;
    printf("kbox_thread_proc()\n");
    done = false;
 
    while (!done) {
        //printf("kbox: wait for call\n");
        call = ipc_wait_for_call(&TASK->kernel_box, SYNCH_NO_TIMEOUT,
            SYNCH_FLAGS_NONE);
 
        if (call != NULL) {
            method = IPC_GET_METHOD(call->data);
 
            if (method == IPC_M_DEBUG_ALL) {
                udebug_call_receive(call);
            }
 
            if (method == IPC_M_PHONE_HUNGUP) {
                printf("kbox: handle hangup message\n");
 
                /* Was it our debugger, who hung up? */
                if (call->sender == TASK->udebug.debugger) {
                    /* Terminate debugging session (if any) */
                    printf("kbox: terminate debug session\n");
                    ipl = interrupts_disable();
                    spinlock_lock(&TASK->lock);
                    udebug_task_cleanup(TASK);
                    spinlock_unlock(&TASK->lock);
                    interrupts_restore(ipl);
                } else {
                    printf("kbox: was not debugger\n");
                }
 
                printf("kbox: continue with hangup message\n");
                IPC_SET_RETVAL(call->data, 0);
                ipc_answer(&TASK->kernel_box, call);
 
                ipl = interrupts_disable();
                spinlock_lock(&TASK->lock);
                spinlock_lock(&TASK->answerbox.lock);
                if (list_empty(&TASK->answerbox.connected_phones)) {
                    /* Last phone has been disconnected */
                    TASK->kb_thread = NULL;
                    done = true;
                    printf("phone list is empty\n");
                }
                spinlock_unlock(&TASK->answerbox.lock);
                spinlock_unlock(&TASK->lock);
                interrupts_restore(ipl);
            }
        }
    }
 
    printf("kbox: finished\n");
}
 
 
/**
 * Connect phone to a task kernel-box specified by id.
 *
 * Note that this is not completely atomic. For optimisation reasons,
 * The task might start cleaning up kbox after the phone has been connected
 * and before a kbox thread has been created. This must be taken into account
 * in the cleanup code.
 *
 * @return      Phone id on success, or negative error code.
 */
int ipc_connect_kbox(task_id_t taskid)
{
    int newphid;
    task_t *ta;
    thread_t *kb_thread;
    ipl_t ipl;
 
    ipl = interrupts_disable();
    spinlock_lock(&tasks_lock);
 
    ta = task_find_by_id(taskid);
    if (ta == NULL) {
        spinlock_unlock(&tasks_lock);
        interrupts_restore(ipl);
        return ENOENT;
    }
 
    atomic_inc(&ta->refcount);
 
    spinlock_unlock(&tasks_lock);
    interrupts_restore(ipl);
 
    mutex_lock(&ta->kb_cleanup_lock);
 
    if (atomic_predec(&ta->refcount) == 0) {
        mutex_unlock(&ta->kb_cleanup_lock);
        task_destroy(ta);
        return ENOENT;
    }
 
    if (ta->kb_finished != false) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return EINVAL;
    }
 
    newphid = phone_alloc();
    if (newphid < 0) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return ELIMIT;
    }
 
    /* Connect the newly allocated phone to the kbox */
    ipc_phone_connect(&TASK->phones[newphid], &ta->kernel_box);
 
    if (ta->kb_thread != NULL) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return newphid;
    }
 
    /* Create a kbox thread */
    kb_thread = thread_create(kbox_thread_proc, NULL, ta, 0, "kbox", false);
    if (!kb_thread) {
        mutex_unlock(&ta->kb_cleanup_lock);
        return ENOMEM;
    }
 
    ta->kb_thread = kb_thread;
    thread_ready(kb_thread);
 
    mutex_unlock(&ta->kb_cleanup_lock);
 
    return newphid;
}
 
#endif /* defined(CONFIG_UDEBUG) */
 
/** @}
 */
 

Rev 3425	Rev 3431
1	/*	1	/*
2	* Copyright (c) 2006 Ondrej Palkovsky	2	* Copyright (c) 2006 Ondrej Palkovsky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genericipc	29	/** @addtogroup genericipc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	/* Lock ordering	35	/* Lock ordering
36	*	36	*
37	* First the answerbox, then the phone.	37	* First the answerbox, then the phone.
38	*/	38	*/
39		39
40	#include <synch/synch.h>	40	#include <synch/synch.h>
41	#include <synch/spinlock.h>	41	#include <synch/spinlock.h>
42	#include <synch/mutex.h>	42	#include <synch/mutex.h>
43	#include <synch/waitq.h>	43	#include <synch/waitq.h>
44	#include <synch/synch.h>	44	#include <synch/synch.h>
45	#include <ipc/ipc.h>	45	#include <ipc/ipc.h>
46	#include <errno.h>	46	#include <errno.h>
47	#include <mm/slab.h>	47	#include <mm/slab.h>
48	#include <arch.h>	48	#include <arch.h>
49	#include <proc/task.h>	49	#include <proc/task.h>
50	#include <memstr.h>	50	#include <memstr.h>
51	#include <debug.h>	51	#include <debug.h>
52		52
53	#include <print.h>	53	#include <print.h>
54	#include <console/console.h>	54	#include <console/console.h>
55	#include <proc/thread.h>	55	#include <proc/thread.h>
56	#include <arch/interrupt.h>	56	#include <arch/interrupt.h>
57	#include <ipc/irq.h>	57	#include <ipc/irq.h>
58		58
59	/** Open channel that is assigned automatically to new tasks */	59	/** Open channel that is assigned automatically to new tasks */
60	answerbox_t *ipc_phone_0 = NULL;	60	answerbox_t *ipc_phone_0 = NULL;
61		61
62	static slab_cache_t *ipc_call_slab;	62	static slab_cache_t *ipc_call_slab;
63		63
64	/** Initialize a call structure.	64	/** Initialize a call structure.
65	*	65	*
66	* @param call Call structure to be initialized.	66	* @param call Call structure to be initialized.
67	*/	67	*/
68	static void _ipc_call_init(call_t *call)	68	static void _ipc_call_init(call_t *call)
69	{	69	{
70	memsetb(call, sizeof(*call), 0);	70	memsetb(call, sizeof(*call), 0);
71	call->callerbox = &TASK->answerbox;	71	call->callerbox = &TASK->answerbox;
72	call->sender = TASK;	72	call->sender = TASK;
73	call->buffer = NULL;	73	call->buffer = NULL;
74	}	74	}
75		75
76	/** Allocate and initialize a call structure.	76	/** Allocate and initialize a call structure.
77	*	77	*
78	* The call is initialized, so that the reply will be directed to	78	* The call is initialized, so that the reply will be directed to
79	* TASK->answerbox.	79	* TASK->answerbox.
80	*	80	*
81	* @param flags Parameters for slab_alloc (e.g FRAME_ATOMIC).	81	* @param flags Parameters for slab_alloc (e.g FRAME_ATOMIC).
82	*	82	*
83	* @return If flags permit it, return NULL, or initialized kernel	83	* @return If flags permit it, return NULL, or initialized kernel
84	* call structure.	84	* call structure.
85	*/	85	*/
86	call_t *ipc_call_alloc(int flags)	86	call_t *ipc_call_alloc(int flags)
87	{	87	{
88	call_t *call;	88	call_t *call;
89		89
90	call = slab_alloc(ipc_call_slab, flags);	90	call = slab_alloc(ipc_call_slab, flags);
91	if (call)	91	if (call)
92	_ipc_call_init(call);	92	_ipc_call_init(call);
93		93
94	return call;	94	return call;
95	}	95	}
96		96
97	/** Initialize a statically allocated call structure.	97	/** Initialize a statically allocated call structure.
98	*	98	*
99	* @param call Statically allocated kernel call structure to be	99	* @param call Statically allocated kernel call structure to be
100	* initialized.	100	* initialized.
101	*/	101	*/
102	void ipc_call_static_init(call_t *call)	102	void ipc_call_static_init(call_t *call)
103	{	103	{
104	_ipc_call_init(call);	104	_ipc_call_init(call);
105	call->flags \|= IPC_CALL_STATIC_ALLOC;	105	call->flags \|= IPC_CALL_STATIC_ALLOC;
106	}	106	}
107		107
108	/** Deallocate a call structure.	108	/** Deallocate a call structure.
109	*	109	*
110	* @param call Call structure to be freed.	110	* @param call Call structure to be freed.
111	*/	111	*/
112	void ipc_call_free(call_t *call)	112	void ipc_call_free(call_t *call)
113	{	113	{
114	ASSERT(!(call->flags & IPC_CALL_STATIC_ALLOC));	114	ASSERT(!(call->flags & IPC_CALL_STATIC_ALLOC));
115	/* Check to see if we have data in the IPC_M_DATA_SEND buffer. */	115	/* Check to see if we have data in the IPC_M_DATA_SEND buffer. */
116	if (call->buffer)	116	if (call->buffer)
117	free(call->buffer);	117	free(call->buffer);
118	slab_free(ipc_call_slab, call);	118	slab_free(ipc_call_slab, call);
119	}	119	}
120		120
121	/** Initialize an answerbox structure.	121	/** Initialize an answerbox structure.
122	*	122	*
123	* @param box Answerbox structure to be initialized.	123	* @param box Answerbox structure to be initialized.
124	* @param task Task to which the answerbox belongs.	124	* @param task Task to which the answerbox belongs.
125	*/	125	*/
126	void ipc_answerbox_init(answerbox_t box, task_t task)	126	void ipc_answerbox_init(answerbox_t box, task_t task)
127	{	127	{
128	spinlock_initialize(&box->lock, "ipc_box_lock");	128	spinlock_initialize(&box->lock, "ipc_box_lock");
129	spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");	129	spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
130	waitq_initialize(&box->wq);	130	waitq_initialize(&box->wq);
131	list_initialize(&box->connected_phones);	131	list_initialize(&box->connected_phones);
132	list_initialize(&box->calls);	132	list_initialize(&box->calls);
133	list_initialize(&box->dispatched_calls);	133	list_initialize(&box->dispatched_calls);
134	list_initialize(&box->answers);	134	list_initialize(&box->answers);
135	list_initialize(&box->irq_notifs);	135	list_initialize(&box->irq_notifs);
136	list_initialize(&box->irq_head);	136	list_initialize(&box->irq_head);
137	box->task = task;	137	box->task = task;
138	}	138	}
139		139
140	/** Connect a phone to an answerbox.	140	/** Connect a phone to an answerbox.
141	*	141	*
142	* @param phone Initialized phone structure.	142	* @param phone Initialized phone structure.
143	* @param box Initialized answerbox structure.	143	* @param box Initialized answerbox structure.
144	*/	144	*/
145	void ipc_phone_connect(phone_t phone, answerbox_t box)	145	void ipc_phone_connect(phone_t phone, answerbox_t box)
146	{	146	{
147	mutex_lock(&phone->lock);	147	mutex_lock(&phone->lock);
148		148
149	phone->state = IPC_PHONE_CONNECTED;	149	phone->state = IPC_PHONE_CONNECTED;
150	phone->callee = box;	150	phone->callee = box;
151		151
152	spinlock_lock(&box->lock);	152	spinlock_lock(&box->lock);
153	list_append(&phone->link, &box->connected_phones);	153	list_append(&phone->link, &box->connected_phones);
154	spinlock_unlock(&box->lock);	154	spinlock_unlock(&box->lock);
155		155
156	mutex_unlock(&phone->lock);	156	mutex_unlock(&phone->lock);
157	}	157	}
158		158
159	/** Initialize a phone structure.	159	/** Initialize a phone structure.
160	*	160	*
161	* @param phone Phone structure to be initialized.	161	* @param phone Phone structure to be initialized.
162	*/	162	*/
163	void ipc_phone_init(phone_t *phone)	163	void ipc_phone_init(phone_t *phone)
164	{	164	{
165	mutex_initialize(&phone->lock, MUTEX_PASSIVE);	165	mutex_initialize(&phone->lock, MUTEX_PASSIVE);
166	phone->callee = NULL;	166	phone->callee = NULL;
167	phone->state = IPC_PHONE_FREE;	167	phone->state = IPC_PHONE_FREE;
168	atomic_set(&phone->active_calls, 0);	168	atomic_set(&phone->active_calls, 0);
169	}	169	}
170		170
171	/** Helper function to facilitate synchronous calls.	171	/** Helper function to facilitate synchronous calls.
172	*	172	*
173	* @param phone Destination kernel phone structure.	173	* @param phone Destination kernel phone structure.
174	* @param request Call structure with request.	174	* @param request Call structure with request.
175	*	175	*
176	* @return EOK on success or EINTR if the sleep was interrupted.	176	* @return EOK on success or EINTR if the sleep was interrupted.
177	*/	177	*/
178	int ipc_call_sync(phone_t phone, call_t request)	178	int ipc_call_sync(phone_t phone, call_t request)
179	{	179	{
180	answerbox_t sync_box;	180	answerbox_t sync_box;
181		181
182	ipc_answerbox_init(&sync_box, TASK);	182	ipc_answerbox_init(&sync_box, TASK);
183		183
184	/* We will receive data in a special box. */	184	/* We will receive data in a special box. */
185	request->callerbox = &sync_box;	185	request->callerbox = &sync_box;
186		186
187	ipc_call(phone, request);	187	ipc_call(phone, request);
188	if (!ipc_wait_for_call(&sync_box, SYNCH_NO_TIMEOUT,	188	if (!ipc_wait_for_call(&sync_box, SYNCH_NO_TIMEOUT,
189	SYNCH_FLAGS_INTERRUPTIBLE))	189	SYNCH_FLAGS_INTERRUPTIBLE))
190	return EINTR;	190	return EINTR;
191	return EOK;	191	return EOK;
192	}	192	}
193		193
194	/** Answer a message which was not dispatched and is not listed in any queue.	194	/** Answer a message which was not dispatched and is not listed in any queue.
195	*	195	*
196	* @param call Call structure to be answered.	196	* @param call Call structure to be answered.
197	*/	197	*/
198	static void _ipc_answer_free_call(call_t *call)	198	static void _ipc_answer_free_call(call_t *call)
199	{	199	{
200	answerbox_t *callerbox = call->callerbox;	200	answerbox_t *callerbox = call->callerbox;
201		201
202	call->flags \|= IPC_CALL_ANSWERED;	202	call->flags \|= IPC_CALL_ANSWERED;
203		203
204	if (call->flags & IPC_CALL_FORWARDED) {	204	if (call->flags & IPC_CALL_FORWARDED) {
205	if (call->caller_phone) {	205	if (call->caller_phone) {
206	/* Demasquerade the caller phone. */	206	/* Demasquerade the caller phone. */
207	call->data.phone = call->caller_phone;	207	call->data.phone = call->caller_phone;
208	}	208	}
209	}	209	}
210		210
211	spinlock_lock(&callerbox->lock);	211	spinlock_lock(&callerbox->lock);
212	list_append(&call->link, &callerbox->answers);	212	list_append(&call->link, &callerbox->answers);
213	spinlock_unlock(&callerbox->lock);	213	spinlock_unlock(&callerbox->lock);
214	waitq_wakeup(&callerbox->wq, WAKEUP_FIRST);	214	waitq_wakeup(&callerbox->wq, WAKEUP_FIRST);
215	}	215	}
216		216
217	/** Answer a message which is in a callee queue.	217	/** Answer a message which is in a callee queue.
218	*	218	*
219	* @param box Answerbox that is answering the message.	219	* @param box Answerbox that is answering the message.
220	* @param call Modified request that is being sent back.	220	* @param call Modified request that is being sent back.
221	*/	221	*/
222	void ipc_answer(answerbox_t box, call_t call)	222	void ipc_answer(answerbox_t box, call_t call)
223	{	223	{
224	/* Remove from active box */	224	/* Remove from active box */
225	spinlock_lock(&box->lock);	225	spinlock_lock(&box->lock);
226	list_remove(&call->link);	226	list_remove(&call->link);
227	spinlock_unlock(&box->lock);	227	spinlock_unlock(&box->lock);
228	/* Send back answer */	228	/* Send back answer */
229	_ipc_answer_free_call(call);	229	_ipc_answer_free_call(call);
230	}	230	}
231		231
232	/** Simulate sending back a message.	232	/** Simulate sending back a message.
233	*	233	*
234	* Most errors are better handled by forming a normal backward	234	* Most errors are better handled by forming a normal backward
235	* message and sending it as a normal answer.	235	* message and sending it as a normal answer.
236	*	236	*
237	* @param phone Phone structure the call should appear to come from.	237	* @param phone Phone structure the call should appear to come from.
238	* @param call Call structure to be answered.	238	* @param call Call structure to be answered.
239	* @param err Return value to be used for the answer.	239	* @param err Return value to be used for the answer.
240	*/	240	*/
241	void ipc_backsend_err(phone_t phone, call_t call, unative_t err)	241	void ipc_backsend_err(phone_t phone, call_t call, unative_t err)
242	{	242	{
243	call->data.phone = phone;	243	call->data.phone = phone;
244	atomic_inc(&phone->active_calls);	244	atomic_inc(&phone->active_calls);
245	IPC_SET_RETVAL(call->data, err);	245	IPC_SET_RETVAL(call->data, err);
246	_ipc_answer_free_call(call);	246	_ipc_answer_free_call(call);
247	}	247	}
248		248
249	/** Unsafe unchecking version of ipc_call.	249	/** Unsafe unchecking version of ipc_call.
250	*	250	*
251	* @param phone Phone structure the call comes from.	251	* @param phone Phone structure the call comes from.
252	* @param box Destination answerbox structure.	252	* @param box Destination answerbox structure.
253	* @param call Call structure with request.	253	* @param call Call structure with request.
254	*/	254	*/
255	static void _ipc_call(phone_t phone, answerbox_t box, call_t *call)	255	static void _ipc_call(phone_t phone, answerbox_t box, call_t *call)
256	{	256	{
257	if (!(call->flags & IPC_CALL_FORWARDED)) {	257	if (!(call->flags & IPC_CALL_FORWARDED)) {
258	atomic_inc(&phone->active_calls);	258	atomic_inc(&phone->active_calls);
259	call->data.phone = phone;	259	call->data.phone = phone;
260	}	260	}
261		261
262	spinlock_lock(&box->lock);	262	spinlock_lock(&box->lock);
263	list_append(&call->link, &box->calls);	263	list_append(&call->link, &box->calls);
264	spinlock_unlock(&box->lock);	264	spinlock_unlock(&box->lock);
265	waitq_wakeup(&box->wq, WAKEUP_FIRST);	265	waitq_wakeup(&box->wq, WAKEUP_FIRST);
266	}	266	}
267		267
268	/** Send an asynchronous request using a phone to an answerbox.	268	/** Send an asynchronous request using a phone to an answerbox.
269	*	269	*
270	* @param phone Phone structure the call comes from and which is	270	* @param phone Phone structure the call comes from and which is
271	* connected to the destination answerbox.	271	* connected to the destination answerbox.
272	* @param call Call structure with request.	272	* @param call Call structure with request.
273	*	273	*
274	* @return Return 0 on success, ENOENT on error.	274	* @return Return 0 on success, ENOENT on error.
275	*/	275	*/
276	int ipc_call(phone_t phone, call_t call)	276	int ipc_call(phone_t phone, call_t call)
277	{	277	{
278	answerbox_t *box;	278	answerbox_t *box;
279		279
280	mutex_lock(&phone->lock);	280	mutex_lock(&phone->lock);
281	if (phone->state != IPC_PHONE_CONNECTED) {	281	if (phone->state != IPC_PHONE_CONNECTED) {
282	mutex_unlock(&phone->lock);	282	mutex_unlock(&phone->lock);
283	if (call->flags & IPC_CALL_FORWARDED) {	283	if (call->flags & IPC_CALL_FORWARDED) {
284	IPC_SET_RETVAL(call->data, EFORWARD);	284	IPC_SET_RETVAL(call->data, EFORWARD);
285	_ipc_answer_free_call(call);	285	_ipc_answer_free_call(call);
286	} else {	286	} else {
287	if (phone->state == IPC_PHONE_HUNGUP)	287	if (phone->state == IPC_PHONE_HUNGUP)
288	ipc_backsend_err(phone, call, EHANGUP);	288	ipc_backsend_err(phone, call, EHANGUP);
289	else	289	else
290	ipc_backsend_err(phone, call, ENOENT);	290	ipc_backsend_err(phone, call, ENOENT);
291	}	291	}
292	return ENOENT;	292	return ENOENT;
293	}	293	}
294	box = phone->callee;	294	box = phone->callee;
295	_ipc_call(phone, box, call);	295	_ipc_call(phone, box, call);
296		296
297	mutex_unlock(&phone->lock);	297	mutex_unlock(&phone->lock);
298	return 0;	298	return 0;
299	}	299	}
300		300
301	/** Disconnect phone from answerbox.	301	/** Disconnect phone from answerbox.
302	*	302	*
303	* This call leaves the phone in the HUNGUP state. The change to 'free' is done	303	* This call leaves the phone in the HUNGUP state. The change to 'free' is done
304	* lazily later.	304	* lazily later.
305	*	305	*
306	* @param phone Phone structure to be hung up.	306	* @param phone Phone structure to be hung up.
307	*	307	*
308	* @return Return 0 if the phone is disconnected.	308	* @return Return 0 if the phone is disconnected.
309	* Return -1 if the phone was already disconnected.	309	* Return -1 if the phone was already disconnected.
310	*/	310	*/
311	int ipc_phone_hangup(phone_t *phone)	311	int ipc_phone_hangup(phone_t *phone)
312	{	312	{
313	answerbox_t *box;	313	answerbox_t *box;
314	call_t *call;	314	call_t *call;
315		315
316	mutex_lock(&phone->lock);	316	mutex_lock(&phone->lock);
317	if (phone->state == IPC_PHONE_FREE \|\|	317	if (phone->state == IPC_PHONE_FREE \|\|
318	phone->state == IPC_PHONE_HUNGUP \|\|	318	phone->state == IPC_PHONE_HUNGUP \|\|
319	phone->state == IPC_PHONE_CONNECTING) {	319	phone->state == IPC_PHONE_CONNECTING) {
320	mutex_unlock(&phone->lock);	320	mutex_unlock(&phone->lock);
321	return -1;	321	return -1;
322	}	322	}
323	box = phone->callee;	323	box = phone->callee;
324	if (phone->state != IPC_PHONE_SLAMMED) {	324	if (phone->state != IPC_PHONE_SLAMMED) {
325	/* Remove myself from answerbox */	325	/* Remove myself from answerbox */
326	spinlock_lock(&box->lock);	326	spinlock_lock(&box->lock);
327	list_remove(&phone->link);	327	list_remove(&phone->link);
328	spinlock_unlock(&box->lock);	328	spinlock_unlock(&box->lock);
329		329
330	if (phone->state != IPC_PHONE_SLAMMED) {	330	if (phone->state != IPC_PHONE_SLAMMED) {
331	call = ipc_call_alloc(0);	331	call = ipc_call_alloc(0);
332	IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);	332	IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
333	call->flags \|= IPC_CALL_DISCARD_ANSWER;	333	call->flags \|= IPC_CALL_DISCARD_ANSWER;
334	_ipc_call(phone, box, call);	334	_ipc_call(phone, box, call);
335	}	335	}
336	}	336	}
337		337
338	phone->state = IPC_PHONE_HUNGUP;	338	phone->state = IPC_PHONE_HUNGUP;
339	mutex_unlock(&phone->lock);	339	mutex_unlock(&phone->lock);
340		340
341	return 0;	341	return 0;
342	}	342	}
343		343
344	/** Forwards call from one answerbox to another one.	344	/** Forwards call from one answerbox to another one.
345	*	345	*
346	* @param call Call structure to be redirected.	346	* @param call Call structure to be redirected.
347	* @param newphone Phone structure to target answerbox.	347	* @param newphone Phone structure to target answerbox.
348	* @param oldbox Old answerbox structure.	348	* @param oldbox Old answerbox structure.
349	* @param mode Flags that specify mode of the forward operation.	349	* @param mode Flags that specify mode of the forward operation.
350	*	350	*
351	* @return Return 0 if forwarding succeeded or an error code if	351	* @return Return 0 if forwarding succeeded or an error code if
352	* there was error.	352	* there was error.
353	*	353	*
354	* The return value serves only as an information for the forwarder,	354	* The return value serves only as an information for the forwarder,
355	* the original caller is notified automatically with EFORWARD.	355	* the original caller is notified automatically with EFORWARD.
356	*/	356	*/
357	int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox, int mode)	357	int ipc_forward(call_t call, phone_t newphone, answerbox_t *oldbox, int mode)
358	{	358	{
359	spinlock_lock(&oldbox->lock);	359	spinlock_lock(&oldbox->lock);
360	list_remove(&call->link);	360	list_remove(&call->link);
361	spinlock_unlock(&oldbox->lock);	361	spinlock_unlock(&oldbox->lock);
362		362
363	if (mode & IPC_FF_ROUTE_FROM_ME) {	363	if (mode & IPC_FF_ROUTE_FROM_ME) {
364	if (!call->caller_phone)	364	if (!call->caller_phone)
365	call->caller_phone = call->data.phone;	365	call->caller_phone = call->data.phone;
366	call->data.phone = newphone;	366	call->data.phone = newphone;
367	}	367	}
368		368
369	return ipc_call(newphone, call);	369	return ipc_call(newphone, call);
370	}	370	}
371		371
372		372
373	/** Wait for a phone call.	373	/** Wait for a phone call.
374	*	374	*
375	* @param box Answerbox expecting the call.	375	* @param box Answerbox expecting the call.
376	* @param usec Timeout in microseconds. See documentation for	376	* @param usec Timeout in microseconds. See documentation for
377	* waitq_sleep_timeout() for decription of its special	377	* waitq_sleep_timeout() for decription of its special
378	* meaning.	378	* meaning.
379	* @param flags Select mode of sleep operation. See documentation for	379	* @param flags Select mode of sleep operation. See documentation for
380	* waitq_sleep_timeout() for description of its special	380	* waitq_sleep_timeout() for description of its special
381	* meaning.	381	* meaning.
382	* @return Recived call structure or NULL.	382	* @return Recived call structure or NULL.
383	*	383	*
384	* To distinguish between a call and an answer, have a look at call->flags.	384	* To distinguish between a call and an answer, have a look at call->flags.
385	*/	385	*/
386	call_t ipc_wait_for_call(answerbox_t box, uint32_t usec, int flags)	386	call_t ipc_wait_for_call(answerbox_t box, uint32_t usec, int flags)
387	{	387	{
388	call_t *request;	388	call_t *request;
389	ipl_t ipl;	389	ipl_t ipl;
390	int rc;	390	int rc;
391		391
392	restart:	392	restart:
393	rc = waitq_sleep_timeout(&box->wq, usec, flags);	393	rc = waitq_sleep_timeout(&box->wq, usec, flags);
394	if (SYNCH_FAILED(rc))	394	if (SYNCH_FAILED(rc))
395	return NULL;	395	return NULL;
396		396
397	spinlock_lock(&box->lock);	397	spinlock_lock(&box->lock);
398	if (!list_empty(&box->irq_notifs)) {	398	if (!list_empty(&box->irq_notifs)) {
399	ipl = interrupts_disable();	399	ipl = interrupts_disable();
400	spinlock_lock(&box->irq_lock);	400	spinlock_lock(&box->irq_lock);
401		401
402	request = list_get_instance(box->irq_notifs.next, call_t, link);	402	request = list_get_instance(box->irq_notifs.next, call_t, link);
403	list_remove(&request->link);	403	list_remove(&request->link);
404		404
405	spinlock_unlock(&box->irq_lock);	405	spinlock_unlock(&box->irq_lock);
406	interrupts_restore(ipl);	406	interrupts_restore(ipl);
407	} else if (!list_empty(&box->answers)) {	407	} else if (!list_empty(&box->answers)) {
408	/* Handle asynchronous answers */	408	/* Handle asynchronous answers */
409	request = list_get_instance(box->answers.next, call_t, link);	409	request = list_get_instance(box->answers.next, call_t, link);
410	list_remove(&request->link);	410	list_remove(&request->link);
411	atomic_dec(&request->data.phone->active_calls);	411	atomic_dec(&request->data.phone->active_calls);
412	} else if (!list_empty(&box->calls)) {	412	} else if (!list_empty(&box->calls)) {
413	/* Handle requests */	413	/* Handle requests */
414	request = list_get_instance(box->calls.next, call_t, link);	414	request = list_get_instance(box->calls.next, call_t, link);
415	list_remove(&request->link);	415	list_remove(&request->link);
416	/* Append request to dispatch queue */	416	/* Append request to dispatch queue */
417	list_append(&request->link, &box->dispatched_calls);	417	list_append(&request->link, &box->dispatched_calls);
418	} else {	418	} else {
419	/* This can happen regularly after ipc_cleanup */	419	/* This can happen regularly after ipc_cleanup */
420	spinlock_unlock(&box->lock);	420	spinlock_unlock(&box->lock);
421	goto restart;	421	goto restart;
422	}	422	}
423	spinlock_unlock(&box->lock);	423	spinlock_unlock(&box->lock);
424	return request;	424	return request;
425	}	425	}
426		426
427	/** Answer all calls from list with EHANGUP answer.	427	/** Answer all calls from list with EHANGUP answer.
428	*	428	*
429	* @param lst Head of the list to be cleaned up.	429	* @param lst Head of the list to be cleaned up.
430	*/	430	*/
431	static void ipc_cleanup_call_list(link_t *lst)	431	static void ipc_cleanup_call_list(link_t *lst)
432	{	432	{
433	call_t *call;	433	call_t *call;
434		434
435	while (!list_empty(lst)) {	435	while (!list_empty(lst)) {
436	call = list_get_instance(lst->next, call_t, link);	436	call = list_get_instance(lst->next, call_t, link);
437	if (call->buffer)	437	if (call->buffer)
438	free(call->buffer);	438	free(call->buffer);
439	list_remove(&call->link);	439	list_remove(&call->link);
440		440
441	IPC_SET_RETVAL(call->data, EHANGUP);	441	IPC_SET_RETVAL(call->data, EHANGUP);
442	_ipc_answer_free_call(call);	442	_ipc_answer_free_call(call);
443	}	443	}
444	}	444	}
445		445
446	/** Disconnects all phones connected to an answerbox.	446	/** Disconnects all phones connected to an answerbox.
447	*	447	*
448	* @param box Answerbox to disconnect phones from.	448	* @param box Answerbox to disconnect phones from.
449	* @param notify_box If true, the answerbox will get a hangup message for	449	* @param notify_box If true, the answerbox will get a hangup message for
450	* each disconnected phone.	450	* each disconnected phone.
451	*/	451	*/
452	static void ipc_answerbox_slam_phones(answerbox_t *box, bool notify_box)	452	static void ipc_answerbox_slam_phones(answerbox_t *box, bool notify_box)
453	{	453	{
454	phone_t *phone;	454	phone_t *phone;
455	DEADLOCK_PROBE_INIT(p_phonelck);	455	DEADLOCK_PROBE_INIT(p_phonelck);
456	ipl_t ipl;	456	ipl_t ipl;
457	call_t *call;	457	call_t *call;
458		458
459	call = ipc_call_alloc(0);	459	call = notify_box ? ipc_call_alloc(0) : NULL;
460		460
461	/* Disconnect all phones connected to our answerbox */	461	/* Disconnect all phones connected to our answerbox */
462	restart_phones:	462	restart_phones:
463	ipl = interrupts_disable();	463	ipl = interrupts_disable();
464	spinlock_lock(&box->lock);	464	spinlock_lock(&box->lock);
465	while (!list_empty(&box->connected_phones)) {	465	while (!list_empty(&box->connected_phones)) {
466	phone = list_get_instance(box->connected_phones.next,	466	phone = list_get_instance(box->connected_phones.next,
467	phone_t, link);	467	phone_t, link);
468	if (SYNCH_FAILED(mutex_trylock(&phone->lock))) {	468	if (SYNCH_FAILED(mutex_trylock(&phone->lock))) {
469	spinlock_unlock(&box->lock);	469	spinlock_unlock(&box->lock);
470	interrupts_restore(ipl);	470	interrupts_restore(ipl);
471	DEADLOCK_PROBE(p_phonelck, DEADLOCK_THRESHOLD);	471	DEADLOCK_PROBE(p_phonelck, DEADLOCK_THRESHOLD);
472	goto restart_phones;	472	goto restart_phones;
473	}	473	}
474		474
475	/* Disconnect phone */	475	/* Disconnect phone */
476	ASSERT(phone->state == IPC_PHONE_CONNECTED);	476	ASSERT(phone->state == IPC_PHONE_CONNECTED);
477		477
478	list_remove(&phone->link);	478	list_remove(&phone->link);
479	phone->state = IPC_PHONE_SLAMMED;	479	phone->state = IPC_PHONE_SLAMMED;
480		480
481	if (notify_box) {	481	if (notify_box) {
482	mutex_unlock(&phone->lock);	482	mutex_unlock(&phone->lock);
483	spinlock_unlock(&box->lock);	483	spinlock_unlock(&box->lock);
484	interrupts_restore(ipl);	484	interrupts_restore(ipl);
485		485
486	/*	486	/*
487	* Send one message to the answerbox for each	487	* Send one message to the answerbox for each
488	* phone. Used to make sure the kbox thread	488	* phone. Used to make sure the kbox thread
489	* wakes up after the last phone has been	489	* wakes up after the last phone has been
490	* disconnected.	490	* disconnected.
491	*/	491	*/
492	IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);	492	IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
493	call->flags \|= IPC_CALL_DISCARD_ANSWER;	493	call->flags \|= IPC_CALL_DISCARD_ANSWER;
494	_ipc_call(phone, box, call);	494	_ipc_call(phone, box, call);
495		495
496	/* Allocate another call in advance */	496	/* Allocate another call in advance */
497	call = ipc_call_alloc(0);	497	call = ipc_call_alloc(0);
498		498
499	/* Must start again */	499	/* Must start again */
500	goto restart_phones;	500	goto restart_phones;

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/src/ipc/ipc.c @ 3433 – Rev 3425 → 3431