Subversion Repositories HelenOS

/*

 * 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

 */

#include <arch.h>

#include <proc/task.h>

#include <proc/thread.h>

#include <errno.h>

#include <memstr.h>

#include <debug.h>

#include <ipc/ipc.h>

#include <ipc/sysipc.h>

#include <ipc/irq.h>

#include <ipc/ipcrsc.h>

#include <arch/interrupt.h>

#include <print.h>

#include <syscall/copy.h>

#include <security/cap.h>

#include <mm/as.h>

#include <print.h>

/**

 * Maximum buffer size allowed for IPC_M_DATA_WRITE and IPC_M_DATA_READ

 * requests.

 */

#define DATA_XFER_LIMIT     (64 * 1024)

#define GET_CHECK_PHONE(phone, phoneid, err) \

{ \

    if (phoneid > IPC_MAX_PHONES) { \

        err; \

    } \

    phone = &TASK->phones[phoneid]; \

}

#define STRUCT_TO_USPACE(dst, src)  copy_to_uspace(dst, src, sizeof(*(src)))

/** Decide if the method is a system method.

 *

 * @param method    Method to be decided.

 *

 * @return      Return 1 if the method is a system method.

 *          Otherwise return 0.

 */

static inline int method_is_system(unative_t method)

{

    if (method <= IPC_M_LAST_SYSTEM)

        return 1;

    return 0;

}

/** Decide if the message with this method is forwardable.

 *

 * - some system messages may be forwarded, for some of them

 *   it is useless

 *

 * @param method    Method to be decided.

 *

 * @return      Return 1 if the method is forwardable.

 *          Otherwise return 0.

 */

static inline int method_is_forwardable(unative_t method)

{

    switch (method) {

    case IPC_M_PHONE_HUNGUP:

        /* This message is meant only for the original recipient. */

        return 0;

    default:

        return 1;

    }

}

/** Decide if the message with this method is immutable on forward.

 *

 * - some system messages may be forwarded but their content cannot be altered

 *

 * @param method    Method to be decided.

 *

 * @return      Return 1 if the method is immutable on forward.

 *          Otherwise return 0.

 */

static inline int method_is_immutable(unative_t method)

{

    switch (method) {

    case IPC_M_SHARE_OUT:

    case IPC_M_SHARE_IN:

    case IPC_M_DATA_WRITE:

    case IPC_M_DATA_READ:

        return 1;

        break;

    default:

        return 0;

    }

}

/***********************************************************************

 * Functions that preprocess answer before sending it to the recepient.

 ***********************************************************************/

/** Decide if the caller (e.g. ipc_answer()) should save the old call contents

 * for answer_preprocess().

 *

 * @param call      Call structure to be decided.

 *

 * @return      Return 1 if the old call contents should be saved.

 *          Return 0 otherwise.

 */

static inline int answer_need_old(call_t *call)

{

    switch (IPC_GET_METHOD(call->data)) {

    case IPC_M_CONNECT_TO_ME:

    case IPC_M_CONNECT_ME_TO:

    case IPC_M_SHARE_OUT:

    case IPC_M_SHARE_IN:

    case IPC_M_DATA_WRITE:

    case IPC_M_DATA_READ:

        return 1;

    default:

        return 0;

    }

}

/** Interpret process answer as control information.

 *

 * This function is called directly after sys_ipc_answer().

 *

 * @param answer    Call structure with the answer.

 * @param olddata   Saved data of the request.

 *

 * @return      Return 0 on success or an error code.

 */

static inline int answer_preprocess(call_t *answer, ipc_data_t *olddata)

{

    int phoneid;

    if ((native_t) IPC_GET_RETVAL(answer->data) == EHANGUP) {

        /* In case of forward, hangup the forwared phone,

         * not the originator

         */

        spinlock_lock(&answer->data.phone->lock);

        spinlock_lock(&TASK->answerbox.lock);

        if (answer->data.phone->state == IPC_PHONE_CONNECTED) {

            list_remove(&answer->data.phone->link);

            answer->data.phone->state = IPC_PHONE_SLAMMED;

        }

        spinlock_unlock(&TASK->answerbox.lock);

        spinlock_unlock(&answer->data.phone->lock);

    }

    if (!olddata)

        return 0;

    if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {

        phoneid = IPC_GET_ARG5(*olddata);

        if (IPC_GET_RETVAL(answer->data)) {

            /* The connection was not accepted */

            phone_dealloc(phoneid);

        } else {

            /* The connection was accepted */

            phone_connect(phoneid, &answer->sender->answerbox);

            /* Set 'phone hash' as arg5 of response */

            IPC_SET_ARG5(answer->data,

                (unative_t) &TASK->phones[phoneid]);

        }

    } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {

        /* If the users accepted call, connect */

        if (!IPC_GET_RETVAL(answer->data)) {

            ipc_phone_connect((phone_t *) IPC_GET_ARG5(*olddata),

                &TASK->answerbox);

        }

    } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_OUT) {

        if (!IPC_GET_RETVAL(answer->data)) {

            /* Accepted, handle as_area receipt */

            ipl_t ipl;

            int rc;

            as_t *as;

            ipl = interrupts_disable();

            spinlock_lock(&answer->sender->lock);

            as = answer->sender->as;

            spinlock_unlock(&answer->sender->lock);

            interrupts_restore(ipl);

            rc = as_area_share(as, IPC_GET_ARG1(*olddata),

                IPC_GET_ARG2(*olddata), AS,

                IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata));

            IPC_SET_RETVAL(answer->data, rc);

            return rc;

        }

    } else if (IPC_GET_METHOD(*olddata) == IPC_M_SHARE_IN) {

        if (!IPC_GET_RETVAL(answer->data)) {

            ipl_t ipl;

            as_t *as;

            int rc;

            ipl = interrupts_disable();

            spinlock_lock(&answer->sender->lock);

            as = answer->sender->as;

            spinlock_unlock(&answer->sender->lock);

            interrupts_restore(ipl);

            rc = as_area_share(AS, IPC_GET_ARG1(answer->data),

                IPC_GET_ARG2(*olddata), as, IPC_GET_ARG1(*olddata),

                IPC_GET_ARG2(answer->data));

            IPC_SET_RETVAL(answer->data, rc);

        }

    } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_READ) {

        ASSERT(!answer->buffer);

        if (!IPC_GET_RETVAL(answer->data)) {

            /* The recipient agreed to send data. */

            uintptr_t src = IPC_GET_ARG1(answer->data);

            uintptr_t dst = IPC_GET_ARG1(*olddata);

            size_t max_size = IPC_GET_ARG2(*olddata);

            size_t size = IPC_GET_ARG2(answer->data);

            if (size <= max_size) {

                /*

                 * Copy the destination VA so that this piece of

                 * information is not lost.

                 */

                IPC_SET_ARG1(answer->data, dst);

                answer->buffer = malloc(size, 0);

                int rc = copy_from_uspace(answer->buffer,

                    (void *) src, size);

                if (rc) {

                    IPC_SET_RETVAL(answer->data, rc);

                    free(answer->buffer);

                    answer->buffer = NULL;

                }

            } else {

                IPC_SET_RETVAL(answer->data, ELIMIT);

            }

        }

    } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_WRITE) {

        ASSERT(answer->buffer);

        if (!IPC_GET_RETVAL(answer->data)) {

            /* The recipient agreed to receive data. */

            int rc;

            uintptr_t dst;

            uintptr_t size;

            uintptr_t max_size;

            dst = IPC_GET_ARG1(answer->data);

            size = IPC_GET_ARG2(answer->data);

            max_size = IPC_GET_ARG2(*olddata);

            if (size <= max_size) {

                rc = copy_to_uspace((void *) dst,

                    answer->buffer, size);

                if (rc)

                    IPC_SET_RETVAL(answer->data, rc);

            } else {

                IPC_SET_RETVAL(answer->data, ELIMIT);

            }

        }

        free(answer->buffer);

        answer->buffer = NULL;

    }

    return 0;

}

static task_t *get_lock_callee_task(phone_t *phone)

{

    answerbox_t *answerbox;

    task_t *ta;

    // FIXME: locking!!!

    answerbox = phone->callee;

    ta = answerbox->task;

    spinlock_lock(&ta->lock);

    return ta;

}

static thread_t *get_task_thread_by_id(task_t *ta, thread_id_t tid)

{

    thread_t *t;

    link_t *cur;

    for (cur = ta->th_head.next; cur != &ta->th_head; cur = cur->next) {

        t = list_get_instance(cur, thread_t, th_link);     

        if (tid == t->tid) return t;

    }

    return NULL;

}

#include <console/klog.h>

static int debug_begin(call_t *call, phone_t *phone)

{

    task_t *ta;

    klog_printf("debug_begin()");

    ta = get_lock_callee_task(phone);

    klog_printf("debugging task %llu", ta->taskid);

    if (ta->being_debugged != false) {

        spinlock_unlock(&ta->lock);

        klog_printf("debug_begin(): busy error");

        return EBUSY;

    }

    ta->being_debugged = true;

    ta->stop_request = true;

    ta->debug_begin_call = call;

    if (ta->not_stoppable_count == 0) {

        ta->debug_begin_call = NULL;

        ta->stop_request = false;

        spinlock_unlock(&ta->lock);

        klog_printf("debug_begin(): immediate backsend");

        return 1; /* actually we need backsend with 0 retval */

    }

    spinlock_unlock(&ta->lock);

    klog_printf("debug_begin() done (wait for stoppability)");

    return 0;

}

static int debug_go(call_t *call, phone_t *phone)

{

    thread_t *t;

    task_t *ta;

    klog_printf("debug_go()");

    ta = get_lock_callee_task(phone);

    ta->debug_go_call = call;

    t = get_task_thread_by_id(ta, IPC_GET_ARG1(call->data));

    if (t == NULL) {

        spinlock_unlock(&ta->lock);

        return ENOENT;

    }

    klog_printf("debug_go(): waitq_wakeup");

    waitq_wakeup(&t->go_wq, WAKEUP_FIRST);

    spinlock_unlock(&ta->lock);

    return 0; /* no backsend */

}

static int debug_args_read(call_t *call, phone_t *phone)

{

    thread_t *t;

    task_t *ta;

    void *uspace_buffer;

    unative_t to_copy;

    int rc;

    klog_printf("debug_args_read()");

    // FIXME: verify task/thread state

    ta = get_lock_callee_task(phone);

    klog_printf("task %llu", ta->taskid);

    t = get_task_thread_by_id(ta, IPC_GET_ARG1(call->data));

    if (t == NULL) {

        spinlock_unlock(&ta->lock);

        return ENOENT;

    }

    uspace_buffer = (void *)IPC_GET_ARG2(call->data);

    to_copy = IPC_GET_ARG3(call->data);

    if (to_copy > 6) to_copy = 6;

    rc = copy_to_uspace(uspace_buffer, t->syscall_args, to_copy);

    if (rc != 0) {

        spinlock_unlock(&ta->lock);

        klog_printf("debug_args_read() - copy failed");

        return rc;

    }

    spinlock_unlock(&ta->lock);

    IPC_SET_ARG1(call->data, to_copy);

    klog_printf("debug_args_read() done");

    return 1; /* actually need becksend with retval 0 */

}

static int debug_thread_read(call_t *call, phone_t *phone)

{

    thread_t *t;

    link_t *cur;

    task_t *ta;

    unative_t *uspace_buffer;

    unative_t to_copy;

    int rc;

    unsigned copied, total;

    unsigned buf_size;

    unative_t tid;

    klog_printf("debug_thread_read()");

    // FIXME: verify task/thread state

    ta = get_lock_callee_task(phone);

    klog_printf("task %llu", ta->taskid);

    uspace_buffer = (void *)IPC_GET_ARG1(call->data);

    buf_size = IPC_GET_ARG2(call->data);

    copied = total = 0;

    for (cur = ta->th_head.next; cur != &ta->th_head; cur = cur->next) {

        t = list_get_instance(cur, thread_t, th_link);

        /* Not interested in kernel threads */

        if ((t->flags & THREAD_FLAG_USPACE) == 0)

            continue;

        //FIXME: id cropped!!

        tid = (unative_t) t->tid;

        to_copy = sizeof(unative_t);

        if (copied + to_copy >= buf_size)

            to_copy = buf_size - copied;

        if (to_copy > 0) {

            rc = copy_to_uspace(uspace_buffer, &tid, to_copy);

            if (rc != 0) {

                spinlock_unlock(&ta->lock);

                klog_printf("debug_thread_read() - copy failed");

                return rc;

            }

        }

        ++uspace_buffer;

        total += sizeof(unative_t);

        copied += to_copy;

    }

    spinlock_unlock(&ta->lock);

    IPC_SET_ARG1(call->data, copied);

    IPC_SET_ARG2(call->data, total);

    klog_printf("debug_thread_read() done");

    return 1; /* actually need becksend with retval 0 */

}

/** Called before the request is sent.

 *

 * @param call      Call structure with the request.

 * @param phone     Phone that the call will be sent through.

 *

 * @return      Return 0 on success, ELIMIT or EPERM on error.

 */

static int request_preprocess(call_t *call, phone_t *phone)

{

    int newphid;

    size_t size;

    uintptr_t src;

    int rc;

    switch (IPC_GET_METHOD(call->data)) {

    case IPC_M_CONNECT_ME_TO:

        newphid = phone_alloc();

        if (newphid < 0)

            return ELIMIT;

        /* Set arg5 for server */

        IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]);

        call->flags |= IPC_CALL_CONN_ME_TO;

        call->priv = newphid;

        break;

    case IPC_M_SHARE_OUT:

        size = as_area_get_size(IPC_GET_ARG1(call->data));

        if (!size)

            return EPERM;

        IPC_SET_ARG2(call->data, size);

        break;

    case IPC_M_DATA_READ:

        size = IPC_GET_ARG2(call->data);

        if ((size <= 0 || (size > DATA_XFER_LIMIT)))

            return ELIMIT;

        break;

    case IPC_M_DATA_WRITE:

        src = IPC_GET_ARG1(call->data);

        size = IPC_GET_ARG2(call->data);

        if ((size <= 0) || (size > DATA_XFER_LIMIT))

            return ELIMIT;

        call->buffer = (uint8_t *) malloc(size, 0);

        rc = copy_from_uspace(call->buffer, (void *) src, size);

        if (rc != 0) {

            free(call->buffer);

            return rc;

        }

        break;

    case IPC_M_DEBUG_BEGIN:

        /* actually need possibility of backsend with 0 result code */

        rc = debug_begin(call, phone);

        return rc;

    case IPC_M_DEBUG_GO:

        rc = debug_go(call, phone);

        return rc;

    case IPC_M_DEBUG_ARGS_READ:

        rc = debug_args_read(call, phone);

        return rc;

    case IPC_M_DEBUG_THREAD_READ:

        rc = debug_thread_read(call, phone);

        return rc;

    default:

        break;

    }

    return 0;

}

/*******************************************************************************

 * Functions called to process received call/answer before passing it to uspace.

 *******************************************************************************/

/** Do basic kernel processing of received call answer.

 *

 * @param call      Call structure with the answer.

 */

static void process_answer(call_t *call)

{

    if (((native_t) IPC_GET_RETVAL(call->data) == EHANGUP) &&

        (call->flags & IPC_CALL_FORWARDED))

        IPC_SET_RETVAL(call->data, EFORWARD);

    if (call->flags & IPC_CALL_CONN_ME_TO) {

        if (IPC_GET_RETVAL(call->data))

            phone_dealloc(call->priv);

        else

            IPC_SET_ARG5(call->data, call->priv);

    }

    if (call->buffer) {

        /* This must be an affirmative answer to IPC_M_DATA_READ. */

        uintptr_t dst = IPC_GET_ARG1(call->data);

        size_t size = IPC_GET_ARG2(call->data);

        int rc = copy_to_uspace((void *) dst, call->buffer, size);

        if (rc)

            IPC_SET_RETVAL(call->data, rc);

        free(call->buffer);

        call->buffer = NULL;

    }

}

/** Do basic kernel processing of received call request.

 *

 * @param box       Destination answerbox structure.

 * @param call      Call structure with the request.

 *

 * @return      Return 0 if the call should be passed to userspace.

 *          Return -1 if the call should be ignored.

 */

static int process_request(answerbox_t *box, call_t *call)

{

    int phoneid;

    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {

        phoneid = phone_alloc();

        if (phoneid < 0) { /* Failed to allocate phone */

            IPC_SET_RETVAL(call->data, ELIMIT);

            ipc_answer(box, call);

            return -1;

        }

        IPC_SET_ARG5(call->data, phoneid);

    }

    switch (IPC_GET_METHOD(call->data)) {

    case IPC_M_DEBUG_BEGIN:

    case IPC_M_DEBUG_END:

    case IPC_M_DEBUG_GO:

    case IPC_M_DEBUG_STOP:

    case IPC_M_DEBUG_GUARD:

        return -1;

    default:

        break;

    }

    return 0;

}

/** Make a fast call over IPC, wait for reply and return to user.

 *

 * This function can handle only three arguments of payload, but is faster than

 * the generic function (i.e. sys_ipc_call_sync_slow()).

 *

 * @param phoneid   Phone handle for the call.

 * @param method    Method of the call.

 * @param arg1      Service-defined payload argument.

 * @param arg2      Service-defined payload argument.

 * @param arg3      Service-defined payload argument.

 * @param data      Address of userspace structure where the reply call will

 *          be stored.

 *

 * @return      Returns 0 on success.

 *          Return ENOENT if there is no such phone handle.

 */

unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method,

    unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data)

{

    call_t call;

    phone_t *phone;

    int res;

    int rc;

    GET_CHECK_PHONE(phone, phoneid, return ENOENT);

    ipc_call_static_init(&call);

    IPC_SET_METHOD(call.data, method);

    IPC_SET_ARG1(call.data, arg1);

    IPC_SET_ARG2(call.data, arg2);

    IPC_SET_ARG3(call.data, arg3);

    /*

     * To achieve deterministic behavior, zero out arguments that are beyond

     * the limits of the fast version.

     */

    IPC_SET_ARG4(call.data, 0);

    IPC_SET_ARG5(call.data, 0);

    if (!(res = request_preprocess(&call, phone))) {

        ipc_call_sync(phone, &call);

        process_answer(&call);

    } else {

        IPC_SET_RETVAL(call.data, res);

    }

    rc = STRUCT_TO_USPACE(&data->args, &call.data.args);

    if (rc != 0)

        return rc;

    return 0;

}

/** Make a synchronous IPC call allowing to transmit the entire payload.

 *

 * @param phoneid   Phone handle for the call.

 * @param question  Userspace address of call data with the request.

 * @param reply     Userspace address of call data where to store the

 *          answer.

 *

 * @return      Zero on success or an error code.

 */

unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question,

    ipc_data_t *reply)

{

    call_t call;

    phone_t *phone;

    int res;

    int rc;

    ipc_call_static_init(&call);

    rc = copy_from_uspace(&call.data.args, &question->args,

        sizeof(call.data.args));

    if (rc != 0)

        return (unative_t) rc;

    GET_CHECK_PHONE(phone, phoneid, return ENOENT);

    if (!(res = request_preprocess(&call, phone))) {

        ipc_call_sync(phone, &call);

        process_answer(&call);

    } else

        IPC_SET_RETVAL(call.data, res);

    rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);

    if (rc != 0)

        return rc;

    return 0;

}

/** Check that the task did not exceed the allowed limit of asynchronous calls.

 *

 * @return      Return 0 if limit not reached or -1 if limit exceeded.

 */

static int check_call_limit(void)

{

    if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {

        atomic_dec(&TASK->active_calls);

        return -1;

    }

    return 0;

}

/** Make a fast asynchronous call over IPC.

 *

 * This function can only handle four arguments of payload, but is faster than

 * the generic function sys_ipc_call_async_slow().

 *

 * @param phoneid   Phone handle for the call.

 * @param method    Method of the call.

 * @param arg1      Service-defined payload argument.

 * @param arg2      Service-defined payload argument.

 * @param arg3      Service-defined payload argument.

 * @param arg4      Service-defined payload argument.

 *

 * @return      Return call hash on success.

 *          Return IPC_CALLRET_FATAL in case of a fatal error and

 *          IPC_CALLRET_TEMPORARY if there are too many pending

 *          asynchronous requests; answers should be handled first.

 */

unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method,

    unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4)

{

    call_t *call;

    phone_t *phone;

    int res;

    if (check_call_limit())

        return IPC_CALLRET_TEMPORARY;

    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);

    call = ipc_call_alloc(0);

    IPC_SET_METHOD(call->data, method);

    IPC_SET_ARG1(call->data, arg1);

    IPC_SET_ARG2(call->data, arg2);

    IPC_SET_ARG3(call->data, arg3);

    IPC_SET_ARG4(call->data, arg4);

    /*

     * To achieve deterministic behavior, zero out arguments that are beyond

     * the limits of the fast version.

     */

    IPC_SET_ARG5(call->data, 0);

    if (!(res = request_preprocess(call, phone)))

        ipc_call(phone, call);

    else

        ipc_backsend_err(phone, call, res);

    return (unative_t) call;

}

/** Make an asynchronous IPC call allowing to transmit the entire payload.

 *

 * @param phoneid   Phone handle for the call.

 * @param data      Userspace address of call data with the request.

 *

 * @return      See sys_ipc_call_async_fast().

 */

unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data)

{

    call_t *call;

    phone_t *phone;

    int res;

    int rc;

    if (check_call_limit())

        return IPC_CALLRET_TEMPORARY;

    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);

    call = ipc_call_alloc(0);

    rc = copy_from_uspace(&call->data.args, &data->args,

        sizeof(call->data.args));

    if (rc != 0) {