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

Subversion Repositories HelenOS

(root)/branches/network/kernel/generic/src/ipc/sysipc.c @ 4746 – Rev 2557 → 2601