WebSVN – HelenOS – Diff – /branches/dynload/kernel/generic/src/ipc/sysipc.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
 */
 
#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_SEND requests. */
#define DATA_SEND_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, for some of them
 *   it is useless
 *
 * @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_AS_AREA_SEND:
    case IPC_M_AS_AREA_RECV:
    case IPC_M_DATA_SEND:
        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_AS_AREA_SEND:
    case IPC_M_AS_AREA_RECV:
    case IPC_M_DATA_SEND:
        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 (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_ARG3(*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 arg3 of response */
            IPC_SET_ARG3(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_ARG3(*olddata),
                &TASK->answerbox);
        }
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_SEND) {
        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_AS_AREA_RECV) {
        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_SEND) {
        if (!IPC_GET_RETVAL(answer->data)) {
            int rc;
            uintptr_t dst;
            uintptr_t size;
 
            ASSERT(answer->buffer);
 
            dst = IPC_GET_ARG1(answer->data);
            size = IPC_GET_ARG3(answer->data);
 
            rc = copy_to_uspace((void *) dst, answer->buffer, size);
            if (rc != 0)
                IPC_SET_RETVAL(answer->data, rc);
            free(answer->buffer);
            answer->buffer = NULL;
        }
    }
    return 0;
}
 
/** Called before the request is sent.
 *
 * @param call      Call structure with the request.
 *
 * @return      Return 0 on success, ELIMIT or EPERM on error.
 */
static int request_preprocess(call_t *call)
{
    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 arg3 for server */
        IPC_SET_ARG3(call->data, (unative_t) &TASK->phones[newphid]);
        call->flags |= IPC_CALL_CONN_ME_TO;
        call->priv = newphid;
        break;
    case IPC_M_AS_AREA_SEND:
        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_SEND:
        src = IPC_GET_ARG2(call->data);
        size = IPC_GET_ARG3(call->data);
       
        if ((size <= 0) || (size > DATA_SEND_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;
    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 (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_ARG3(call->data, call->priv);
    }
}
 
/** 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_ARG3(call->data, phoneid);
    }
    return 0;
}
 
/** Make a fast call over IPC, wait for reply and return to user.
 *
 * This function can handle only one argument of payload, but is faster than
 * the generic function (i.e. sys_ipc_call_sync()).
 *
 * @param phoneid   Phone handle for the call.
 * @param method    Method of the call.
 * @param arg1      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, ipc_data_t *data)
{
    call_t call;
    phone_t *phone;
    int res;
 
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
 
    ipc_call_static_init(&call);
    IPC_SET_METHOD(call.data, method);
    IPC_SET_ARG1(call.data, arg1);
 
    if (!(res = request_preprocess(&call))) {
        ipc_call_sync(phone, &call);
        process_answer(&call);
    } else {
        IPC_SET_RETVAL(call.data, res);
    }
    STRUCT_TO_USPACE(&data->args, &call.data.args);
 
    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(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))) {
        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 two arguments of payload, but is faster than
 * the generic function sys_ipc_call_async().
 *
 * @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.
 *
 * @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)
{
    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, 0);
 
    if (!(res = request_preprocess(call)))
        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(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) {
        ipc_call_free(call);
        return (unative_t) rc;
    }
    if (!(res = request_preprocess(call)))
        ipc_call(phone, call);
    else
        ipc_backsend_err(phone, call, res);
 
    return (unative_t) call;
}
 
/** Forward a received call to another destination.
 *
 * @param callid    Hash of the call to forward.
 * @param phoneid   Phone handle to use for forwarding.
 * @param method    New method to use for the forwarded call.
 * @param arg1      New value of the first argument for the forwarded call.
 *
 * @return      Return 0 on succes, otherwise return an error code.
 *
 * In case the original method is a system method, ARG1 and ARG2 are overwritten
 * in the forwarded message with the new method and the new arg1, respectively.
 * Otherwise the METHOD and ARG1 are rewritten with the new method and arg1,
 * respectively. Also note there is a set of immutable methods, for which the
 * new method and argument is not set and these values are ignored.
 *
 * Warning: If implementing non-fast version, make sure that
 *          ARG3 is not rewritten for certain system IPC
 */
unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid,
    unative_t method, unative_t arg1)
{
    call_t *call;
    phone_t *phone;
 
    call = get_call(callid);
    if (!call)
        return ENOENT;
 
    call->flags |= IPC_CALL_FORWARDED;
 
    GET_CHECK_PHONE(phone, phoneid, {
        IPC_SET_RETVAL(call->data, EFORWARD);
        ipc_answer(&TASK->answerbox, call);
        return ENOENT;
    });    
 
    if (!method_is_forwardable(IPC_GET_METHOD(call->data))) {
        IPC_SET_RETVAL(call->data, EFORWARD);
        ipc_answer(&TASK->answerbox, call);
        return EPERM;
    }
 
    /*
     * Userspace is not allowed to change method of system methods on
     * forward, allow changing ARG1 and ARG2 by means of method and arg1.
     * If the method is immutable, don't change anything.
     */
    if (!method_is_immutable(IPC_GET_METHOD(call->data))) {
        if (method_is_system(IPC_GET_METHOD(call->data))) {
            if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
                phone_dealloc(IPC_GET_ARG3(call->data));
 
            IPC_SET_ARG1(call->data, method);
            IPC_SET_ARG2(call->data, arg1);
        } else {
            IPC_SET_METHOD(call->data, method);
            IPC_SET_ARG1(call->data, arg1);
        }
    }
 
    return ipc_forward(call, phone, &TASK->answerbox);
}
 
/** Answer an IPC call - fast version.
 *
 * This function can handle only two return arguments of payload, but is faster
 * than the generic sys_ipc_answer().
 *
 * @param callid    Hash of the call to be answered.
 * @param retval    Return value of the answer.
 * @param arg1      Service-defined return value.
 * @param arg2      Service-defined return value.
 *
 * @return      Return 0 on success, otherwise return an error code.   
 */
unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval,
    unative_t arg1, unative_t arg2)
{
    call_t *call;
    ipc_data_t saved_data;
    int saveddata = 0;
    int rc;
 
    /* Do not answer notification callids */
    if (callid & IPC_CALLID_NOTIFICATION)
        return 0;
 
    call = get_call(callid);
    if (!call)
        return ENOENT;
 
    if (answer_need_old(call)) {
        memcpy(&saved_data, &call->data, sizeof(call->data));
        saveddata = 1;
    }
 
    IPC_SET_RETVAL(call->data, retval);
    IPC_SET_ARG1(call->data, arg1);
    IPC_SET_ARG2(call->data, arg2);
    rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
 
    ipc_answer(&TASK->answerbox, call);
    return rc;
}
 
/** Answer an IPC call.
 *
 * @param callid    Hash of the call to be answered.
 * @param data      Userspace address of call data with the answer.
 *
 * @return      Return 0 on success, otherwise return an error code.
 */
unative_t sys_ipc_answer(unative_t callid, ipc_data_t *data)
{
    call_t *call;
    ipc_data_t saved_data;
    int saveddata = 0;
    int rc;
 
    /* Do not answer notification callids */
    if (callid & IPC_CALLID_NOTIFICATION)
        return 0;
 
    call = get_call(callid);
    if (!call)
        return ENOENT;
 
    if (answer_need_old(call)) {
        memcpy(&saved_data, &call->data, sizeof(call->data));
        saveddata = 1;
    }
    rc = copy_from_uspace(&call->data.args, &data->args,
        sizeof(call->data.args));
    if (rc != 0)
        return rc;
 
    rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
   
    ipc_answer(&TASK->answerbox, call);
 
    return rc;
}
 
/** Hang up a phone.
 *
 * @param       Phone handle of the phone to be hung up.
 *
 * @return      Return 0 on success or an error code.
 */
unative_t sys_ipc_hangup(int phoneid)
{
    phone_t *phone;
 
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
 
    if (ipc_phone_hangup(phone))
        return -1;
 
    return 0;
}
 
/** Wait for an incoming IPC call or an answer.
 *
 * @param calldata  Pointer to buffer where the call/answer data is stored.
 * @param usec      Timeout. See waitq_sleep_timeout() for explanation.
 * @param flags     Select mode of sleep operation. See waitq_sleep_timeout()
 *          for explanation.
 *
 * @return      Hash of the call.
 *          If IPC_CALLID_NOTIFICATION bit is set in the hash, the
 *          call is a notification. IPC_CALLID_ANSWERED denotes an
 *          answer.
 */
unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags)
{
    call_t *call;
 
restart:   
    call = ipc_wait_for_call(&TASK->answerbox, usec,
        flags | SYNCH_FLAGS_INTERRUPTIBLE);
    if (!call)
        return 0;
 
    if (call->flags & IPC_CALL_NOTIF) {
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
 
        /* Set in_phone_hash to the interrupt counter */
        call->data.phone = (void *) call->priv;
       
        STRUCT_TO_USPACE(calldata, &call->data);
 
        ipc_call_free(call);
       
        return ((unative_t) call) | IPC_CALLID_NOTIFICATION;
    }
 
    if (call->flags & IPC_CALL_ANSWERED) {
        process_answer(call);
 
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
 
        atomic_dec(&TASK->active_calls);
 
        if (call->flags & IPC_CALL_DISCARD_ANSWER) {
            ipc_call_free(call);
            goto restart;
        }
 
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
        ipc_call_free(call);
 
        return ((unative_t) call) | IPC_CALLID_ANSWERED;
    }
 
    if (process_request(&TASK->answerbox, call))
        goto restart;
 
    /* Include phone address('id') of the caller in the request,
     * copy whole call->data, not only call->data.args */
    if (STRUCT_TO_USPACE(calldata, &call->data)) {
        return 0;
    }
    return (unative_t)call;
}
 
/** Connect an IRQ handler to a task.
 *
 * @param inr       IRQ number.
 * @param devno     Device number.
 * @param method    Method to be associated with the notification.
 * @param ucode     Uspace pointer to the top-half pseudocode.
 *
 * @return      EPERM or a return code returned by ipc_irq_register().
 */
unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method,
    irq_code_t *ucode)
{
    if (!(cap_get(TASK) & CAP_IRQ_REG))
        return EPERM;
 
    return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode);
}
 
/** Disconnect an IRQ handler from a task.
 *
 * @param inr       IRQ number.
 * @param devno     Device number.
 *
 * @return      Zero on success or EPERM on error..
 */
unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno)
{
    if (!(cap_get(TASK) & CAP_IRQ_REG))
        return EPERM;
 
    ipc_irq_unregister(&TASK->answerbox, inr, devno);
 
    return 0;
}
 
/** @}
 */
 

Rev 2556	Rev 2557
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	#include <arch.h>	35	#include <arch.h>
36	#include <proc/task.h>	36	#include <proc/task.h>
37	#include <proc/thread.h>	37	#include <proc/thread.h>
38	#include <errno.h>	38	#include <errno.h>
39	#include <memstr.h>	39	#include <memstr.h>
40	#include <debug.h>	40	#include <debug.h>
41	#include <ipc/ipc.h>	41	#include <ipc/ipc.h>
42	#include <ipc/sysipc.h>	42	#include <ipc/sysipc.h>
43	#include <ipc/irq.h>	43	#include <ipc/irq.h>
44	#include <ipc/ipcrsc.h>	44	#include <ipc/ipcrsc.h>
45	#include <arch/interrupt.h>	45	#include <arch/interrupt.h>
46	#include <print.h>	46	#include <print.h>
47	#include <syscall/copy.h>	47	#include <syscall/copy.h>
48	#include <security/cap.h>	48	#include <security/cap.h>
49	#include <mm/as.h>	49	#include <mm/as.h>
50	#include <print.h>	50	#include <print.h>
51		51
52	/** Maximum buffer size allowed for IPC_M_DATA_SEND requests. */	52	/** Maximum buffer size allowed for IPC_M_DATA_SEND requests. */
53	#define DATA_SEND_LIMIT (64 * 1024)	53	#define DATA_SEND_LIMIT (64 * 1024)
54		54
55	#define GET_CHECK_PHONE(phone, phoneid, err) \	55	#define GET_CHECK_PHONE(phone, phoneid, err) \
56	{ \	56	{ \
57	if (phoneid > IPC_MAX_PHONES) { \	57	if (phoneid > IPC_MAX_PHONES) { \
58	err; \	58	err; \
59	} \	59	} \
60	phone = &TASK->phones[phoneid]; \	60	phone = &TASK->phones[phoneid]; \
61	}	61	}
62		62
63	#define STRUCT_TO_USPACE(dst, src) copy_to_uspace(dst, src, sizeof(*(src)))	63	#define STRUCT_TO_USPACE(dst, src) copy_to_uspace(dst, src, sizeof(*(src)))
64		64
65	/** Decide if the method is a system method.	65	/** Decide if the method is a system method.
66	*	66	*
67	* @param method Method to be decided.	67	* @param method Method to be decided.
68	*	68	*
69	* @return Return 1 if the method is a system method.	69	* @return Return 1 if the method is a system method.
70	* Otherwise return 0.	70	* Otherwise return 0.
71	*/	71	*/
72	static inline int is_system_method(unative_t method)	72	static inline int method_is_system(unative_t method)
73	{	73	{
74	if (method <= IPC_M_LAST_SYSTEM)	74	if (method <= IPC_M_LAST_SYSTEM)
75	return 1;	75	return 1;
76	return 0;	76	return 0;
77	}	77	}
78		78
79	/** Decide if the message with this method is forwardable.	79	/** Decide if the message with this method is forwardable.
80	*	80	*
81	* - some system messages may be forwarded, for some of them	81	* - some system messages may be forwarded, for some of them
82	* it is useless	82	* it is useless
83	*	83	*
84	* @param method Method to be decided.	84	* @param method Method to be decided.
85	*	85	*
86	* @return Return 1 if the method is forwardable.	86	* @return Return 1 if the method is forwardable.
87	* Otherwise return 0.	87	* Otherwise return 0.
88	*/	88	*/
89	static inline int is_forwardable(unative_t method)	89	static inline int method_is_forwardable(unative_t method)
90	{	90	{
91	switch (method) {	91	switch (method) {
92	case IPC_M_PHONE_HUNGUP:	92	case IPC_M_PHONE_HUNGUP:
93	case IPC_M_AS_AREA_SEND:	-
94	case IPC_M_AS_AREA_RECV:	-
95	case IPC_M_DATA_SEND:	-
96	/* This message is meant only for the original recipient. */	93	/* This message is meant only for the original recipient. */
97	return 0;	94	return 0;
98	default:	95	default:
99	return 1;	96	return 1;
100	}	97	}
101	}	98	}
102		99
-		100	/** Decide if the message with this method is immutable on forward.
-		101	*
-		102	* - some system messages may be forwarded, for some of them
-		103	* it is useless
-		104	*
-		105	* @param method Method to be decided.
-		106	*
-		107	* @return Return 1 if the method is immutable on forward.
-		108	* Otherwise return 0.
-		109	*/
-		110	static inline int method_is_immutable(unative_t method)
-		111	{
-		112	switch (method) {
-		113	case IPC_M_AS_AREA_SEND:
-		114	case IPC_M_AS_AREA_RECV:
-		115	case IPC_M_DATA_SEND:
-		116	return 1;
-		117	break;
-		118	default:
-		119	return 0;
-		120	}
-		121	}
-		122
103		123
104	/***********************************************************************	124	/***********************************************************************
105	* Functions that preprocess answer before sending it to the recepient.	125	* Functions that preprocess answer before sending it to the recepient.
106	***********************************************************************/	126	***********************************************************************/
107		127
108	/** Decide if the caller (e.g. ipc_answer()) should save the old call contents	128	/** Decide if the caller (e.g. ipc_answer()) should save the old call contents
109	* for answer_preprocess().	129	* for answer_preprocess().
110	*	130	*
111	* @param call Call structure to be decided.	131	* @param call Call structure to be decided.
112	*	132	*
113	* @return Return 1 if the old call contents should be saved.	133	* @return Return 1 if the old call contents should be saved.
114	* Return 0 otherwise.	134	* Return 0 otherwise.
115	*/	135	*/
116	static inline int answer_need_old(call_t *call)	136	static inline int answer_need_old(call_t *call)
117	{	137	{
118	switch (IPC_GET_METHOD(call->data)) {	138	switch (IPC_GET_METHOD(call->data)) {
119	case IPC_M_CONNECT_TO_ME:	139	case IPC_M_CONNECT_TO_ME:
120	case IPC_M_CONNECT_ME_TO:	140	case IPC_M_CONNECT_ME_TO:
121	case IPC_M_AS_AREA_SEND:	141	case IPC_M_AS_AREA_SEND:
122	case IPC_M_AS_AREA_RECV:	142	case IPC_M_AS_AREA_RECV:
123	case IPC_M_DATA_SEND:	143	case IPC_M_DATA_SEND:
124	return 1;	144	return 1;
125	default:	145	default:
126	return 0;	146	return 0;
127	}	147	}
128	}	148	}
129		149
130	/** Interpret process answer as control information.	150	/** Interpret process answer as control information.
131	*	151	*
132	* This function is called directly after sys_ipc_answer().	152	* This function is called directly after sys_ipc_answer().
133	*	153	*
134	* @param answer Call structure with the answer.	154	* @param answer Call structure with the answer.
135	* @param olddata Saved data of the request.	155	* @param olddata Saved data of the request.
136	*	156	*
137	* @return Return 0 on success or an error code.	157	* @return Return 0 on success or an error code.
138	*/	158	*/
139	static inline int answer_preprocess(call_t answer, ipc_data_t olddata)	159	static inline int answer_preprocess(call_t answer, ipc_data_t olddata)
140	{	160	{
141	int phoneid;	161	int phoneid;
142		162
143	if (IPC_GET_RETVAL(answer->data) == EHANGUP) {	163	if (IPC_GET_RETVAL(answer->data) == EHANGUP) {
144	/* In case of forward, hangup the forwared phone,	164	/* In case of forward, hangup the forwared phone,
145	* not the originator	165	* not the originator
146	*/	166	*/
147	spinlock_lock(&answer->data.phone->lock);	167	spinlock_lock(&answer->data.phone->lock);
148	spinlock_lock(&TASK->answerbox.lock);	168	spinlock_lock(&TASK->answerbox.lock);
149	if (answer->data.phone->state == IPC_PHONE_CONNECTED) {	169	if (answer->data.phone->state == IPC_PHONE_CONNECTED) {
150	list_remove(&answer->data.phone->link);	170	list_remove(&answer->data.phone->link);
151	answer->data.phone->state = IPC_PHONE_SLAMMED;	171	answer->data.phone->state = IPC_PHONE_SLAMMED;
152	}	172	}
153	spinlock_unlock(&TASK->answerbox.lock);	173	spinlock_unlock(&TASK->answerbox.lock);
154	spinlock_unlock(&answer->data.phone->lock);	174	spinlock_unlock(&answer->data.phone->lock);
155	}	175	}
156		176
157	if (!olddata)	177	if (!olddata)
158	return 0;	178	return 0;
159		179
160	if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {	180	if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {
161	phoneid = IPC_GET_ARG3(*olddata);	181	phoneid = IPC_GET_ARG3(*olddata);
162	if (IPC_GET_RETVAL(answer->data)) {	182	if (IPC_GET_RETVAL(answer->data)) {
163	/* The connection was not accepted */	183	/* The connection was not accepted */
164	phone_dealloc(phoneid);	184	phone_dealloc(phoneid);
165	} else {	185	} else {
166	/* The connection was accepted */	186	/* The connection was accepted */
167	phone_connect(phoneid, &answer->sender->answerbox);	187	phone_connect(phoneid, &answer->sender->answerbox);
168	/* Set 'phone hash' as arg3 of response */	188	/* Set 'phone hash' as arg3 of response */
169	IPC_SET_ARG3(answer->data,	189	IPC_SET_ARG3(answer->data,
170	(unative_t) &TASK->phones[phoneid]);	190	(unative_t) &TASK->phones[phoneid]);
171	}	191	}
172	} else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {	192	} else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {
173	/* If the users accepted call, connect */	193	/* If the users accepted call, connect */
174	if (!IPC_GET_RETVAL(answer->data)) {	194	if (!IPC_GET_RETVAL(answer->data)) {
175	ipc_phone_connect((phone_t ) IPC_GET_ARG3(olddata),	195	ipc_phone_connect((phone_t ) IPC_GET_ARG3(olddata),
176	&TASK->answerbox);	196	&TASK->answerbox);
177	}	197	}
178	} else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_SEND) {	198	} else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_SEND) {
179	if (!IPC_GET_RETVAL(answer->data)) {	199	if (!IPC_GET_RETVAL(answer->data)) {
180	/* Accepted, handle as_area receipt */	200	/* Accepted, handle as_area receipt */
181	ipl_t ipl;	201	ipl_t ipl;
182	int rc;	202	int rc;
183	as_t *as;	203	as_t *as;
184		204
185	ipl = interrupts_disable();	205	ipl = interrupts_disable();
186	spinlock_lock(&answer->sender->lock);	206	spinlock_lock(&answer->sender->lock);
187	as = answer->sender->as;	207	as = answer->sender->as;
188	spinlock_unlock(&answer->sender->lock);	208	spinlock_unlock(&answer->sender->lock);
189	interrupts_restore(ipl);	209	interrupts_restore(ipl);
190		210
191	rc = as_area_share(as, IPC_GET_ARG1(*olddata),	211	rc = as_area_share(as, IPC_GET_ARG1(*olddata),
192	IPC_GET_ARG2(*olddata), AS,	212	IPC_GET_ARG2(*olddata), AS,
193	IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata));	213	IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata));
194	IPC_SET_RETVAL(answer->data, rc);	214	IPC_SET_RETVAL(answer->data, rc);
195	return rc;	215	return rc;
196	}	216	}
197	} else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_RECV) {	217	} else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_RECV) {
198	if (!IPC_GET_RETVAL(answer->data)) {	218	if (!IPC_GET_RETVAL(answer->data)) {
199	ipl_t ipl;	219	ipl_t ipl;
200	as_t *as;	220	as_t *as;
201	int rc;	221	int rc;
202		222
203	ipl = interrupts_disable();	223	ipl = interrupts_disable();
204	spinlock_lock(&answer->sender->lock);	224	spinlock_lock(&answer->sender->lock);
205	as = answer->sender->as;	225	as = answer->sender->as;
206	spinlock_unlock(&answer->sender->lock);	226	spinlock_unlock(&answer->sender->lock);
207	interrupts_restore(ipl);	227	interrupts_restore(ipl);
208		228
209	rc = as_area_share(AS, IPC_GET_ARG1(answer->data),	229	rc = as_area_share(AS, IPC_GET_ARG1(answer->data),
210	IPC_GET_ARG2(olddata), as, IPC_GET_ARG1(olddata),	230	IPC_GET_ARG2(olddata), as, IPC_GET_ARG1(olddata),
211	IPC_GET_ARG2(answer->data));	231	IPC_GET_ARG2(answer->data));
212	IPC_SET_RETVAL(answer->data, rc);	232	IPC_SET_RETVAL(answer->data, rc);
213	}	233	}
214	} else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_SEND) {	234	} else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_SEND) {
215	if (!IPC_GET_RETVAL(answer->data)) {	235	if (!IPC_GET_RETVAL(answer->data)) {
216	int rc;	236	int rc;
217	uintptr_t dst;	237	uintptr_t dst;
218	uintptr_t size;	238	uintptr_t size;
219		239
220	ASSERT(answer->buffer);	240	ASSERT(answer->buffer);
221		241
222	dst = IPC_GET_ARG1(answer->data);	242	dst = IPC_GET_ARG1(answer->data);
223	size = IPC_GET_ARG3(answer->data);	243	size = IPC_GET_ARG3(answer->data);
224		244
225	rc = copy_to_uspace((void *) dst, answer->buffer, size);	245	rc = copy_to_uspace((void *) dst, answer->buffer, size);
226	if (rc != 0)	246	if (rc != 0)
227	IPC_SET_RETVAL(answer->data, rc);	247	IPC_SET_RETVAL(answer->data, rc);
228	free(answer->buffer);	248	free(answer->buffer);
229	answer->buffer = NULL;	249	answer->buffer = NULL;
230	}	250	}
231	}	251	}
232	return 0;	252	return 0;
233	}	253	}
234		254
235	/** Called before the request is sent.	255	/** Called before the request is sent.
236	*	256	*
237	* @param call Call structure with the request.	257	* @param call Call structure with the request.
238	*	258	*
239	* @return Return 0 on success, ELIMIT or EPERM on error.	259	* @return Return 0 on success, ELIMIT or EPERM on error.
240	*/	260	*/
241	static int request_preprocess(call_t *call)	261	static int request_preprocess(call_t *call)
242	{	262	{
243	int newphid;	263	int newphid;
244	size_t size;	264	size_t size;
245	uintptr_t src;	265	uintptr_t src;
246	int rc;	266	int rc;
247		267
248	switch (IPC_GET_METHOD(call->data)) {	268	switch (IPC_GET_METHOD(call->data)) {
249	case IPC_M_CONNECT_ME_TO:	269	case IPC_M_CONNECT_ME_TO:
250	newphid = phone_alloc();	270	newphid = phone_alloc();
251	if (newphid < 0)	271	if (newphid < 0)
252	return ELIMIT;	272	return ELIMIT;
253	/* Set arg3 for server */	273	/* Set arg3 for server */
254	IPC_SET_ARG3(call->data, (unative_t) &TASK->phones[newphid]);	274	IPC_SET_ARG3(call->data, (unative_t) &TASK->phones[newphid]);
255	call->flags \|= IPC_CALL_CONN_ME_TO;	275	call->flags \|= IPC_CALL_CONN_ME_TO;
256	call->priv = newphid;	276	call->priv = newphid;
257	break;	277	break;
258	case IPC_M_AS_AREA_SEND:	278	case IPC_M_AS_AREA_SEND:
259	size = as_area_get_size(IPC_GET_ARG1(call->data));	279	size = as_area_get_size(IPC_GET_ARG1(call->data));
260	if (!size)	280	if (!size)
261	return EPERM;	281	return EPERM;
262	IPC_SET_ARG2(call->data, size);	282	IPC_SET_ARG2(call->data, size);
263	break;	283	break;
264	case IPC_M_DATA_SEND:	284	case IPC_M_DATA_SEND:
265	src = IPC_GET_ARG2(call->data);	285	src = IPC_GET_ARG2(call->data);
266	size = IPC_GET_ARG3(call->data);	286	size = IPC_GET_ARG3(call->data);
267		287
268	if ((size <= 0) \|\| (size > DATA_SEND_LIMIT))	288	if ((size <= 0) \|\| (size > DATA_SEND_LIMIT))
269	return ELIMIT;	289	return ELIMIT;
270		290
271	call->buffer = (uint8_t *) malloc(size, 0);	291	call->buffer = (uint8_t *) malloc(size, 0);
272	rc = copy_from_uspace(call->buffer, (void *) src, size);	292	rc = copy_from_uspace(call->buffer, (void *) src, size);
273	if (rc != 0) {	293	if (rc != 0) {
274	free(call->buffer);	294	free(call->buffer);
275	return rc;	295	return rc;
276	}	296	}
277	break;	297	break;
278	default:	298	default:
279	break;	299	break;
280	}	300	}
281	return 0;	301	return 0;
282	}	302	}
283		303
284	/*******************************************************************************	304	/*******************************************************************************
285	* Functions called to process received call/answer before passing it to uspace.	305	* Functions called to process received call/answer before passing it to uspace.
286	*******************************************************************************/	306	*******************************************************************************/
287		307
288	/** Do basic kernel processing of received call answer.	308	/** Do basic kernel processing of received call answer.
289	*	309	*
290	* @param call Call structure with the answer.	310	* @param call Call structure with the answer.
291	*/	311	*/
292	static void process_answer(call_t *call)	312	static void process_answer(call_t *call)
293	{	313	{
294	if (IPC_GET_RETVAL(call->data) == EHANGUP &&	314	if (IPC_GET_RETVAL(call->data) == EHANGUP &&
295	(call->flags & IPC_CALL_FORWARDED))	315	(call->flags & IPC_CALL_FORWARDED))
296	IPC_SET_RETVAL(call->data, EFORWARD);	316	IPC_SET_RETVAL(call->data, EFORWARD);
297		317
298	if (call->flags & IPC_CALL_CONN_ME_TO) {	318	if (call->flags & IPC_CALL_CONN_ME_TO) {
299	if (IPC_GET_RETVAL(call->data))	319	if (IPC_GET_RETVAL(call->data))
300	phone_dealloc(call->priv);	320	phone_dealloc(call->priv);
301	else	321	else
302	IPC_SET_ARG3(call->data, call->priv);	322	IPC_SET_ARG3(call->data, call->priv);
303	}	323	}
304	}	324	}
305		325
306	/** Do basic kernel processing of received call request.	326	/** Do basic kernel processing of received call request.
307	*	327	*
308	* @param box Destination answerbox structure.	328	* @param box Destination answerbox structure.
309	* @param call Call structure with the request.	329	* @param call Call structure with the request.
310	*	330	*
311	* @return Return 0 if the call should be passed to userspace.	331	* @return Return 0 if the call should be passed to userspace.
312	* Return -1 if the call should be ignored.	332	* Return -1 if the call should be ignored.
313	*/	333	*/
314	static int process_request(answerbox_t box, call_t call)	334	static int process_request(answerbox_t box, call_t call)
315	{	335	{
316	int phoneid;	336	int phoneid;
317		337
318	if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {	338	if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
319	phoneid = phone_alloc();	339	phoneid = phone_alloc();
320	if (phoneid < 0) { /* Failed to allocate phone */	340	if (phoneid < 0) { /* Failed to allocate phone */
321	IPC_SET_RETVAL(call->data, ELIMIT);	341	IPC_SET_RETVAL(call->data, ELIMIT);
322	ipc_answer(box, call);	342	ipc_answer(box, call);
323	return -1;	343	return -1;
324	}	344	}
325	IPC_SET_ARG3(call->data, phoneid);	345	IPC_SET_ARG3(call->data, phoneid);
326	}	346	}
327	return 0;	347	return 0;
328	}	348	}
329		349
330	/** Make a fast call over IPC, wait for reply and return to user.	350	/** Make a fast call over IPC, wait for reply and return to user.
331	*	351	*
332	* This function can handle only one argument of payload, but is faster than	352	* This function can handle only one argument of payload, but is faster than
333	* the generic function (i.e. sys_ipc_call_sync()).	353	* the generic function (i.e. sys_ipc_call_sync()).
334	*	354	*
335	* @param phoneid Phone handle for the call.	355	* @param phoneid Phone handle for the call.
336	* @param method Method of the call.	356	* @param method Method of the call.
337	* @param arg1 Service-defined payload argument.	357	* @param arg1 Service-defined payload argument.
338	* @param data Address of userspace structure where the reply call will	358	* @param data Address of userspace structure where the reply call will
339	* be stored.	359	* be stored.
340	*	360	*
341	* @return Returns 0 on success.	361	* @return Returns 0 on success.
342	* Return ENOENT if there is no such phone handle.	362	* Return ENOENT if there is no such phone handle.
343	*/	363	*/
344	unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method,	364	unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method,
345	unative_t arg1, ipc_data_t *data)	365	unative_t arg1, ipc_data_t *data)
346	{	366	{
347	call_t call;	367	call_t call;
348	phone_t *phone;	368	phone_t *phone;
349	int res;	369	int res;
350		370
351	GET_CHECK_PHONE(phone, phoneid, return ENOENT);	371	GET_CHECK_PHONE(phone, phoneid, return ENOENT);
352		372
353	ipc_call_static_init(&call);	373	ipc_call_static_init(&call);
354	IPC_SET_METHOD(call.data, method);	374	IPC_SET_METHOD(call.data, method);
355	IPC_SET_ARG1(call.data, arg1);	375	IPC_SET_ARG1(call.data, arg1);
356		376
357	if (!(res = request_preprocess(&call))) {	377	if (!(res = request_preprocess(&call))) {
358	ipc_call_sync(phone, &call);	378	ipc_call_sync(phone, &call);
359	process_answer(&call);	379	process_answer(&call);
360	} else {	380	} else {
361	IPC_SET_RETVAL(call.data, res);	381	IPC_SET_RETVAL(call.data, res);
362	}	382	}
363	STRUCT_TO_USPACE(&data->args, &call.data.args);	383	STRUCT_TO_USPACE(&data->args, &call.data.args);
364		384
365	return 0;	385	return 0;
366	}	386	}
367		387
368	/** Make a synchronous IPC call allowing to transmit the entire payload.	388	/** Make a synchronous IPC call allowing to transmit the entire payload.
369	*	389	*
370	* @param phoneid Phone handle for the call.	390	* @param phoneid Phone handle for the call.
371	* @param question Userspace address of call data with the request.	391	* @param question Userspace address of call data with the request.
372	* @param reply Userspace address of call data where to store the	392	* @param reply Userspace address of call data where to store the
373	* answer.	393	* answer.
374	*	394	*
375	* @return Zero on success or an error code.	395	* @return Zero on success or an error code.
376	*/	396	*/
377	unative_t sys_ipc_call_sync(unative_t phoneid, ipc_data_t *question,	397	unative_t sys_ipc_call_sync(unative_t phoneid, ipc_data_t *question,
378	ipc_data_t *reply)	398	ipc_data_t *reply)
379	{	399	{
380	call_t call;	400	call_t call;
381	phone_t *phone;	401	phone_t *phone;
382	int res;	402	int res;
383	int rc;	403	int rc;
384		404
385	ipc_call_static_init(&call);	405	ipc_call_static_init(&call);
386	rc = copy_from_uspace(&call.data.args, &question->args,	406	rc = copy_from_uspace(&call.data.args, &question->args,
387	sizeof(call.data.args));	407	sizeof(call.data.args));
388	if (rc != 0)	408	if (rc != 0)
389	return (unative_t) rc;	409	return (unative_t) rc;
390		410
391	GET_CHECK_PHONE(phone, phoneid, return ENOENT);	411	GET_CHECK_PHONE(phone, phoneid, return ENOENT);
392		412
393	if (!(res = request_preprocess(&call))) {	413	if (!(res = request_preprocess(&call))) {
394	ipc_call_sync(phone, &call);	414	ipc_call_sync(phone, &call);
395	process_answer(&call);	415	process_answer(&call);
396	} else	416	} else
397	IPC_SET_RETVAL(call.data, res);	417	IPC_SET_RETVAL(call.data, res);
398		418
399	rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);	419	rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);
400	if (rc != 0)	420	if (rc != 0)
401	return rc;	421	return rc;
402		422
403	return 0;	423	return 0;
404	}	424	}
405		425
406	/** Check that the task did not exceed the allowed limit of asynchronous calls.	426	/** Check that the task did not exceed the allowed limit of asynchronous calls.
407	*	427	*
408	* @return Return 0 if limit not reached or -1 if limit exceeded.	428	* @return Return 0 if limit not reached or -1 if limit exceeded.
409	*/	429	*/
410	static int check_call_limit(void)	430	static int check_call_limit(void)
411	{	431	{
412	if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {	432	if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
413	atomic_dec(&TASK->active_calls);	433	atomic_dec(&TASK->active_calls);
414	return -1;	434	return -1;
415	}	435	}
416	return 0;	436	return 0;
417	}	437	}
418		438
419	/** Make a fast asynchronous call over IPC.	439	/** Make a fast asynchronous call over IPC.
420	*	440	*
421	* This function can only handle two arguments of payload, but is faster than	441	* This function can only handle two arguments of payload, but is faster than
422	* the generic function sys_ipc_call_async().	442	* the generic function sys_ipc_call_async().
423	*	443	*
424	* @param phoneid Phone handle for the call.	444	* @param phoneid Phone handle for the call.
425	* @param method Method of the call.	445	* @param method Method of the call.
426	* @param arg1 Service-defined payload argument.	446	* @param arg1 Service-defined payload argument.
427	* @param arg2 Service-defined payload argument.	447	* @param arg2 Service-defined payload argument.
428	*	448	*
429	* @return Return call hash on success.	449	* @return Return call hash on success.
430	* Return IPC_CALLRET_FATAL in case of a fatal error and	450	* Return IPC_CALLRET_FATAL in case of a fatal error and
431	* IPC_CALLRET_TEMPORARY if there are too many pending	451	* IPC_CALLRET_TEMPORARY if there are too many pending
432	* asynchronous requests; answers should be handled first.	452	* asynchronous requests; answers should be handled first.
433	*/	453	*/
434	unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method,	454	unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method,
435	unative_t arg1, unative_t arg2)	455	unative_t arg1, unative_t arg2)
436	{	456	{
437	call_t *call;	457	call_t *call;
438	phone_t *phone;	458	phone_t *phone;
439	int res;	459	int res;
440		460
441	if (check_call_limit())	461	if (check_call_limit())
442	return IPC_CALLRET_TEMPORARY;	462	return IPC_CALLRET_TEMPORARY;
443		463
444	GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);	464	GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
445		465
446	call = ipc_call_alloc(0);	466	call = ipc_call_alloc(0);
447	IPC_SET_METHOD(call->data, method);	467	IPC_SET_METHOD(call->data, method);
448	IPC_SET_ARG1(call->data, arg1);	468	IPC_SET_ARG1(call->data, arg1);
449	IPC_SET_ARG2(call->data, arg2);	469	IPC_SET_ARG2(call->data, arg2);
450	IPC_SET_ARG3(call->data, 0);	470	IPC_SET_ARG3(call->data, 0);
451		471
452	if (!(res = request_preprocess(call)))	472	if (!(res = request_preprocess(call)))
453	ipc_call(phone, call);	473	ipc_call(phone, call);
454	else	474	else
455	ipc_backsend_err(phone, call, res);	475	ipc_backsend_err(phone, call, res);
456		476
457	return (unative_t) call;	477	return (unative_t) call;
458	}	478	}
459		479
460	/** Make an asynchronous IPC call allowing to transmit the entire payload.	480	/** Make an asynchronous IPC call allowing to transmit the entire payload.
461	*	481	*
462	* @param phoneid Phone handle for the call.	482	* @param phoneid Phone handle for the call.
463	* @param data Userspace address of call data with the request.	483	* @param data Userspace address of call data with the request.
464	*	484	*
465	* @return See sys_ipc_call_async_fast().	485	* @return See sys_ipc_call_async_fast().
466	*/	486	*/
467	unative_t sys_ipc_call_async(unative_t phoneid, ipc_data_t *data)	487	unative_t sys_ipc_call_async(unative_t phoneid, ipc_data_t *data)
468	{	488	{
469	call_t *call;	489	call_t *call;
470	phone_t *phone;	490	phone_t *phone;
471	int res;	491	int res;
472	int rc;	492	int rc;
473		493
474	if (check_call_limit())	494	if (check_call_limit())
475	return IPC_CALLRET_TEMPORARY;	495	return IPC_CALLRET_TEMPORARY;
476		496
477	GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);	497	GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);

Subversion Repositories HelenOS

(root)/branches/dynload/kernel/generic/src/ipc/sysipc.c @ 3674 – Rev 2556 → 2557