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/klog.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((uintptr_t) 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);
    _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);
    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.
 */
void 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);
    ipc_wait_for_call(&sync_box, SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE);
}
 
/** 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;
 
    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)
        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 = ipc_call_alloc(0);
 
    /* 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);
}
 
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) {
        klog_printf("join kb_thread..");
        thread_join(TASK->kb_thread);
        thread_detach(TASK->kb_thread);
        klog_printf("join done");
        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);
}
 
 
/** 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);
 
    /* Clean up kbox thread and communications */
    ipc_kbox_cleanup();
 
    /* 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: %d\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:%llu M:%d A1:%d A2:%d A3:%d "
            "A4:%d A5:%d 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:%llu M:%d A1:%d A2:%d A3:%d "
            "A4:%d A5:%d 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:%d A1:%d A2:%d A3:%d A4:%d A5:%d 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);
}
 
#include <ipc/ipcrsc.h>
#include <console/klog.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;
    klog_printf("kbox_thread_proc()");
    done = false;
 
    while (!done) {
        //klog_printf("kbox: wait for call");
        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) {
                klog_printf("kbox: handle hangup message");
 
                /* Was it our debugger, who hung up? */
                if (call->sender == TASK->udebug.debugger) {
                    /* Terminate debugging session (if any) */
                    klog_printf("kbox: terminate debug session");
                    ipl = interrupts_disable();
                    spinlock_lock(&TASK->lock);
                    udebug_task_cleanup(TASK);
                    spinlock_unlock(&TASK->lock);
                    interrupts_restore(ipl);
                } else {
                    klog_printf("kbox: was not debugger");
                }
 
                klog_printf("kbox: continue with hangup message");
                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;
                    klog_printf("phone list is empty");
                }
                spinlock_unlock(&TASK->answerbox.lock);
                spinlock_unlock(&TASK->lock);
                interrupts_restore(ipl);
            }
        }
    }
 
    klog_printf("kbox: finished");
}
 
 
/**
 * 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;
}
 
/** @}
 */
 

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

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/generic/src/ipc/ipc.c @ 3043 – Rev 3037 → 3042