WebSVN – HelenOS – Diff – /trunk/uspace/lib/libc/generic/ipc.c


/*
 * Copyright (c) 2006 Ondrej Palkovsky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup libc
 * @{
 * @}
 */
 
/** @addtogroup libcipc IPC
 * @brief HelenOS uspace IPC
 * @{
 * @ingroup libc
 */
/** @file
 */
 
#include <ipc/ipc.h>
#include <libc.h>
#include <malloc.h>
#include <errno.h>
#include <libadt/list.h>
#include <stdio.h>
#include <unistd.h>
#include <futex.h>
#include <kernel/synch/synch.h>
#include <async.h>
#include <fibril.h>
#include <assert.h>
 
/**
 * Structures of this type are used for keeping track of sent asynchronous calls
 * and queing unsent calls.
 */
typedef struct {
    link_t list;
 
    ipc_async_callback_t callback;
    void *private;
    union {
        ipc_callid_t callid;
        struct {
            ipc_call_t data;
            int phoneid;
        } msg;
    } u;
    fid_t fid;  /**< Fibril waiting for sending this call. */
} async_call_t;
 
LIST_INITIALIZE(dispatched_calls);
 
/** List of asynchronous calls that were not accepted by kernel.
 *
 * It is protected by async_futex, because if the call cannot be sent into the
 * kernel, the async framework is used automatically.
 */
LIST_INITIALIZE(queued_calls);
 
static atomic_t ipc_futex = FUTEX_INITIALIZER;
 
/** Make a fast synchronous call.
 *
 * Only three payload arguments can be passed using this function. However, this
 * function is faster than the generic ipc_call_sync_slow() because the payload
 * is passed directly in registers.
 *
 * @param phoneid   Phone handle for the call.
 * @param method    Requested method.
 * @param arg1      Service-defined payload argument.
 * @param arg2      Service-defined payload argument.
 * @param arg3      Service-defined payload argument.
 * @param result1   If non-NULL, the return ARG1 will be stored there.
 * @param result2   If non-NULL, the return ARG2 will be stored there.
 * @param result3   If non-NULL, the return ARG3 will be stored there.
 * @param result4   If non-NULL, the return ARG4 will be stored there.
 * @param result5   If non-NULL, the return ARG5 will be stored there.
 *
 * @return      Negative values represent errors returned by IPC.
 *          Otherwise the RETVAL of the answer is returned.
 */
int
ipc_call_sync_fast(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,
    ipcarg_t arg3, ipcarg_t *result1, ipcarg_t *result2, ipcarg_t *result3,
    ipcarg_t *result4, ipcarg_t *result5)
{
    ipc_call_t resdata;
    int callres;
   
    callres = __SYSCALL6(SYS_IPC_CALL_SYNC_FAST, phoneid, method, arg1,
        arg2, arg3, (sysarg_t) &resdata);
    if (callres)
        return callres;
    if (result1)
        *result1 = IPC_GET_ARG1(resdata);
    if (result2)
        *result2 = IPC_GET_ARG2(resdata);
    if (result3)
        *result3 = IPC_GET_ARG3(resdata);
    if (result4)
        *result4 = IPC_GET_ARG4(resdata);
    if (result5)
        *result5 = IPC_GET_ARG5(resdata);
 
    return IPC_GET_RETVAL(resdata);
}
 
/** Make a synchronous call transmitting 5 arguments of payload.
 *
 * @param phoneid   Phone handle for the call.
 * @param method    Requested method.
 * @param arg1      Service-defined payload argument.
 * @param arg2      Service-defined payload argument.
 * @param arg3      Service-defined payload argument.
 * @param arg4      Service-defined payload argument.
 * @param arg5      Service-defined payload argument.
 * @param result1   If non-NULL, storage for the first return argument.
 * @param result2   If non-NULL, storage for the second return argument.
 * @param result3   If non-NULL, storage for the third return argument.
 * @param result4   If non-NULL, storage for the fourth return argument.
 * @param result5   If non-NULL, storage for the fifth return argument.
 *
 * @return      Negative value means IPC error.
 *          Otherwise the RETVAL of the answer.
 */
int
ipc_call_sync_slow(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,
    ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, ipcarg_t *result1,
    ipcarg_t *result2, ipcarg_t *result3, ipcarg_t *result4, ipcarg_t *result5)
{
    ipc_call_t data;
    int callres;
 
    IPC_SET_METHOD(data, method);
    IPC_SET_ARG1(data, arg1);
    IPC_SET_ARG2(data, arg2);
    IPC_SET_ARG3(data, arg3);
    IPC_SET_ARG4(data, arg4);
    IPC_SET_ARG5(data, arg5);
 
    callres = __SYSCALL3(SYS_IPC_CALL_SYNC_SLOW, phoneid, (sysarg_t) &data,
        (sysarg_t) &data);
    if (callres)
        return callres;
 
    if (result1)
        *result1 = IPC_GET_ARG1(data);
    if (result2)
        *result2 = IPC_GET_ARG2(data);
    if (result3)
        *result3 = IPC_GET_ARG3(data);
    if (result4)
        *result4 = IPC_GET_ARG4(data);
    if (result5)
        *result5 = IPC_GET_ARG5(data);
 
    return IPC_GET_RETVAL(data);
}
 
/** Syscall to send asynchronous message.
 *
 * @param phoneid   Phone handle for the call.
 * @param data      Call data with the request.
 *
 * @return      Hash of the call or an error code.
 */
static ipc_callid_t _ipc_call_async(int phoneid, ipc_call_t *data)
{
    return __SYSCALL2(SYS_IPC_CALL_ASYNC_SLOW, phoneid, (sysarg_t) data);
}
 
/** Prolog to ipc_call_async_*() functions.
 *
 * @param private   Argument for the answer/error callback.
 * @param callback  Answer/error callback.
 *
 * @return      New, partially initialized async_call structure or NULL.
 */
static inline async_call_t *ipc_prepare_async(void *private,
    ipc_async_callback_t callback)
{
    async_call_t *call;
 
    call = malloc(sizeof(*call));
    if (!call) {
        if (callback)
            callback(private, ENOMEM, NULL);
        return NULL;
    }
    call->callback = callback;
    call->private = private;
 
    return call;
}
 
/** Epilogue of ipc_call_async_*() functions.
 *
 * @param callid    Value returned by the SYS_IPC_CALL_ASYNC_* syscall.
 * @param phoneid   Phone handle through which the call was made.
 * @param call      async_call structure returned by ipc_prepare_async().
 * @param can_preempt   If non-zero, the current fibril can be preempted in this
 *          call.
 */
static inline void ipc_finish_async(ipc_callid_t callid, int phoneid,
    async_call_t *call, int can_preempt)
{
    if (!call) { /* Nothing to do regardless if failed or not */
        futex_up(&ipc_futex);
        return;
    }
 
    if (callid == IPC_CALLRET_FATAL) {
        futex_up(&ipc_futex);
        /* Call asynchronous handler with error code */
        if (call->callback)
            call->callback(call->private, ENOENT, NULL);
        free(call);
        return;
    }
 
    if (callid == IPC_CALLRET_TEMPORARY) {
        futex_up(&ipc_futex);
 
        call->u.msg.phoneid = phoneid;
       
        futex_down(&async_futex);
        list_append(&call->list, &queued_calls);
 
        if (can_preempt) {
            call->fid = fibril_get_id();
            fibril_switch(FIBRIL_TO_MANAGER);
            /* Async futex unlocked by previous call */
        } else {
            call->fid = 0;
            futex_up(&async_futex);
        }
        return;
    }
    call->u.callid = callid;
    /* Add call to the list of dispatched calls */
    list_append(&call->list, &dispatched_calls);
    futex_up(&ipc_futex);
   
}
 
/** Make a fast asynchronous call.
 *
 * This function can only handle four arguments of payload. It is, however,
 * faster than the more generic ipc_call_async_slow().
 *
 * Note that this function is a void function.
 * During normal opertation, answering this call will trigger the callback.
 * In case of fatal error, call the callback handler with the proper error code.
 * If the call cannot be temporarily made, queue it.
 *
 * @param phoneid   Phone handle for the call.
 * @param method    Requested method.
 * @param arg1      Service-defined payload argument.
 * @param arg2      Service-defined payload argument.
 * @param arg3      Service-defined payload argument.
 * @param arg4      Service-defined payload argument.
 * @param private   Argument to be passed to the answer/error callback.
 * @param callback  Answer or error callback.
 * @param can_preempt   If non-zero, the current fibril will be preempted in
 *          case the kernel temporarily refuses to accept more
 *          asynchronous calls.
 */
void ipc_call_async_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, void *private,
    ipc_async_callback_t callback, int can_preempt)
{
    async_call_t *call = NULL;
    ipc_callid_t callid;
 
    if (callback) {
        call = ipc_prepare_async(private, callback);
        if (!call)
            return;
    }
 
    /*
     * We need to make sure that we get callid before another thread
     * accesses the queue again.
     */
    futex_down(&ipc_futex);
    callid = __SYSCALL6(SYS_IPC_CALL_ASYNC_FAST, phoneid, method, arg1,
        arg2, arg3, arg4);
 
    if (callid == IPC_CALLRET_TEMPORARY) {
        if (!call) {
            call = ipc_prepare_async(private, callback);
            if (!call)
                return;
        }
        IPC_SET_METHOD(call->u.msg.data, method);
        IPC_SET_ARG1(call->u.msg.data, arg1);
        IPC_SET_ARG2(call->u.msg.data, arg2);
        IPC_SET_ARG3(call->u.msg.data, arg3);
        IPC_SET_ARG4(call->u.msg.data, arg4);
    }
    ipc_finish_async(callid, phoneid, call, can_preempt);
}
 
/** Make an asynchronous call transmitting the entire payload.
 *
 * Note that this function is a void function.
 * During normal opertation, answering this call will trigger the callback.
 * In case of fatal error, call the callback handler with the proper error code.
 * If the call cannot be temporarily made, queue it.
 *
 * @param phoneid   Phone handle for the call.
 * @param method    Requested method.
 * @param arg1      Service-defined payload argument.
 * @param arg2      Service-defined payload argument.
 * @param arg3      Service-defined payload argument.
 * @param arg4      Service-defined payload argument.
 * @param arg5      Service-defined payload argument.
 * @param private   Argument to be passed to the answer/error callback.
 * @param callback  Answer or error callback.
 * @param can_preempt   If non-zero, the current fibril will be preempted in
 *          case the kernel temporarily refuses to accept more
 *          asynchronous calls.
 *
 */
void ipc_call_async_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, void *private,
    ipc_async_callback_t callback, int can_preempt)
{
    async_call_t *call;
    ipc_callid_t callid;
 
    call = ipc_prepare_async(private, callback);
    if (!call)
        return;
 
    IPC_SET_METHOD(call->u.msg.data, method);
    IPC_SET_ARG1(call->u.msg.data, arg1);
    IPC_SET_ARG2(call->u.msg.data, arg2);
    IPC_SET_ARG3(call->u.msg.data, arg3);
    IPC_SET_ARG4(call->u.msg.data, arg4);
    IPC_SET_ARG5(call->u.msg.data, arg5);
    /*
     * We need to make sure that we get callid before another thread
     * accesses the queue again.
     */
    futex_down(&ipc_futex);
    callid = _ipc_call_async(phoneid, &call->u.msg.data);
 
    ipc_finish_async(callid, phoneid, call, can_preempt);
}
 
 
/** Answer a received call - fast version.
 *
 * The fast answer makes use of passing retval and first two arguments in
 * registers. If you need to return more, use the ipc_answer() instead.
 *
 * @param callid    Hash of the call being answered.
 * @param retval    Return value.
 * @param arg1      First return argument.
 * @param arg2      Second return argument.
 *
 * @return      Zero on success or a value from @ref errno.h on failure.
 */
ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1,
    ipcarg_t arg2)
{
    return __SYSCALL4(SYS_IPC_ANSWER_FAST, callid, retval, arg1, arg2);
}
 
/** Answer a received call - full version.
 *
 * @param callid    Hash of the call being answered.
 * @param call      Call structure with the answer.
 *          Must be already initialized by the responder.
 *
 * @return      Zero on success or a value from @ref errno.h on failure.
 */
ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call)
{
    return __SYSCALL2(SYS_IPC_ANSWER, callid, (sysarg_t) call);
}
 
 
/** Try to dispatch queued calls from the async queue. */
static void try_dispatch_queued_calls(void)
{
    async_call_t *call;
    ipc_callid_t callid;
 
    /** @todo
     * Integrate intelligently ipc_futex, so that it is locked during
     * ipc_call_async_*(), until it is added to dispatched_calls.
     */
    futex_down(&async_futex);
    while (!list_empty(&queued_calls)) {
        call = list_get_instance(queued_calls.next, async_call_t, list);
        callid = _ipc_call_async(call->u.msg.phoneid, &call->u.msg.data);
        if (callid == IPC_CALLRET_TEMPORARY) {
            break;
        }
        list_remove(&call->list);
 
        futex_up(&async_futex);
        if (call->fid)
            fibril_add_ready(call->fid);
       
        if (callid == IPC_CALLRET_FATAL) {
            if (call->callback)
                call->callback(call->private, ENOENT, NULL);
            free(call);
        } else {
            call->u.callid = callid;
            futex_down(&ipc_futex);
            list_append(&call->list, &dispatched_calls);
            futex_up(&ipc_futex);
        }
        futex_down(&async_futex);
    }
    futex_up(&async_futex);
}
 
/** Handle a received answer.
 *
 * Find the hash of the answer and call the answer callback.
 *
 * @todo Make it use hash table.
 *
 * @param callid    Hash of the received answer.
 *          The answer has the same hash as the request OR'ed with
 *          the IPC_CALLID_ANSWERED bit.
 * @param data      Call data of the answer.
 */
static void handle_answer(ipc_callid_t callid, ipc_call_t *data)
{
    link_t *item;
    async_call_t *call;
 
    callid &= ~IPC_CALLID_ANSWERED;
   
    futex_down(&ipc_futex);
    for (item = dispatched_calls.next; item != &dispatched_calls;
        item = item->next) {
        call = list_get_instance(item, async_call_t, list);
        if (call->u.callid == callid) {
            list_remove(&call->list);
            futex_up(&ipc_futex);
            if (call->callback)
                call->callback(call->private,
                    IPC_GET_RETVAL(*data), data);
            free(call);
            return;
        }
    }
    futex_up(&ipc_futex);
}
 
 
/** Wait for a first call to come.
 *
 * @param call      Storage where the incoming call data will be stored.
 * @param usec      Timeout in microseconds
 * @param flags     Flags passed to SYS_IPC_WAIT (blocking, nonblocking).
 *
 * @return      Hash of the call. Note that certain bits have special
 *          meaning. IPC_CALLID_ANSWERED will be set in an answer
 *          and IPC_CALLID_NOTIFICATION is used for notifications.
 *         
 */
ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags)
{
    ipc_callid_t callid;
 
    callid = __SYSCALL3(SYS_IPC_WAIT, (sysarg_t) call, usec, flags);
    /* Handle received answers */
    if (callid & IPC_CALLID_ANSWERED) {
        handle_answer(callid, call);
        try_dispatch_queued_calls();
    }
 
    return callid;
}
 
/** Wait some time for an IPC call.
 *
 * The call will return after an answer is received.
 *
 * @param call      Storage where the incoming call data will be stored.
 * @param usec      Timeout in microseconds.
 *
 * @return      Hash of the answer.
 */
ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *call, uint32_t usec)
{
    ipc_callid_t callid;
 
    do {
        callid = ipc_wait_cycle(call, usec, SYNCH_FLAGS_NONE);
    } while (callid & IPC_CALLID_ANSWERED);
 
    return callid;
}
 
/** Check if there is an IPC call waiting to be picked up.
 *
 * @param call      Storage where the incoming call will be stored.
 * @return      Hash of the answer.
 */
ipc_callid_t ipc_trywait_for_call(ipc_call_t *call)
{
    ipc_callid_t callid;
 
    do {
        callid = ipc_wait_cycle(call, SYNCH_NO_TIMEOUT,
            SYNCH_FLAGS_NON_BLOCKING);
    } while (callid & IPC_CALLID_ANSWERED);
 
    return callid;
}
 
/** Ask destination to do a callback connection.
 *
 * @param phoneid   Phone handle used for contacting the other side.
 * @param arg1      Service-defined argument.
 * @param arg2      Service-defined argument.
 * @param phonehash Storage where the library will store an opaque
 *          identifier of the phone that will be used for incoming
 *          calls. This identifier can be used for connection
 *          tracking.
 *
 * @return      Zero on success or a negative error code.
 */
int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phonehash)
{
    return ipc_call_sync_2_3(phoneid, IPC_M_CONNECT_TO_ME, arg1, arg2,
        NULL, NULL, phonehash);
}
 
/** Ask through phone for a new connection to some service.
 *
 * @param phoneid   Phone handle used for contacting the other side.
 * @param arg1      User defined argument.
 * @param arg2      User defined argument.
 *
 * @return      New phone handle on success or a negative error code.
 */
int ipc_connect_me_to(int phoneid, int arg1, int arg2)
{
    ipcarg_t newphid;
    int res;
 
    res = ipc_call_sync_2_3(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, NULL,
        NULL, &newphid);
    if (res)
        return res;
    return newphid;
}
 
/** Hang up a phone.
 *
 * @param phoneid   Handle of the phone to be hung up.
 *
 * @return      Zero on success or a negative error code.
 */
int ipc_hangup(int phoneid)
{
    return __SYSCALL1(SYS_IPC_HANGUP, phoneid);
}
 
/** Register IRQ notification.
 *
 * @param inr       IRQ number.
 * @param devno     Device number of the device generating inr.
 * @param method    Use this method for notifying me.
 * @param ucode     Top-half pseudocode handler.
 *
 * @return      Value returned by the kernel.
 */
int ipc_register_irq(int inr, int devno, int method, irq_code_t *ucode)
{
    return __SYSCALL4(SYS_IPC_REGISTER_IRQ, inr, devno, method,
        (sysarg_t) ucode);
}
 
/** Unregister IRQ notification.
 *
 * @param inr       IRQ number.
 * @param devno     Device number of the device generating inr.
 *
 * @return      Value returned by the kernel.
 */
int ipc_unregister_irq(int inr, int devno)
{
    return __SYSCALL2(SYS_IPC_UNREGISTER_IRQ, inr, devno);
}
 
/** 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 for the forwarded call.
 * @param arg1      New value of the first argument for the forwarded call.
 *
 * @return      Zero on success or an error code.
 *
 * For non-system methods, the old method and arg1 are rewritten by the new
 * values. For system methods, the new method and arg1 are written to the old
 * arg1 and arg2, respectivelly.
 */
int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method, ipcarg_t arg1)
{
    return __SYSCALL4(SYS_IPC_FORWARD_FAST, callid, phoneid, method, arg1);
}
 
/** Wrapper for making IPC_M_DATA_SEND calls.
 *
 * @param phoneid   Phone that will be used to contact the receiving side.
 * @param src       Address of the beginning of the source buffer.
 * @param size      Size of the source buffer.
 *
 * @return      Zero on success or a negative error code from errno.h.
 */
int ipc_data_send(int phoneid, void *src, size_t size)
{
    return ipc_call_sync_3_0(phoneid, IPC_M_DATA_SEND, 0, (ipcarg_t) src,
        (ipcarg_t) size);
}
 
/** Wrapper for receiving the IPC_M_DATA_SEND calls.
 *
 * This wrapper only makes it more comfortable to receive IPC_M_DATA_SEND calls
 * so that the user doesn't have to remember the meaning of each IPC argument.
 *
 * So far, this wrapper is to be used from within a connection fibril.
 *
 * @param callid    Storage where the hash of the IPC_M_DATA_SEND call will
 *          be stored.
 * @param call      Storage where the incoming call will be stored.
 * @param dst       Storage where the suggested destination address will
 *          be stored. May be NULL.
 * @param size      Storage where the suggested size will be stored. May be
 *          NULL
 *
 * @return      Non-zero on success, zero on failure.
 */
int ipc_data_receive(ipc_callid_t *callid, ipc_call_t *call, void **dst,
    size_t *size)
{
    assert(callid);
    assert(call);
 
    *callid = async_get_call(call);
    if (IPC_GET_METHOD(*call) != IPC_M_DATA_SEND)
        return 0;
    if (dst)
        *dst = (void *) IPC_GET_ARG1(*call);
    if (size)
        *size = (size_t) IPC_GET_ARG3(*call);
    return 1;
}
 
/** Wrapper for answering the IPC_M_DATA_SEND calls.
 *
 * This wrapper only makes it more comfortable to answer IPC_M_DATA_SEND calls
 * so that the user doesn't have to remember the meaning of each IPC argument.
 *
 * @param callid    Hash of the IPC_M_DATA_SEND call to answer.
 * @param call      Call structure with the request.
 * @param dst       Final destination address for the IPC_M_DATA_SEND call.
 * @param size      Final size for the IPC_M_DATA_SEND call.
 *
 * @return      Zero on success or a value from @ref errno.h on failure.
 */
ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call, void *dst,
    size_t size)
{
    IPC_SET_RETVAL(*call, EOK);
    IPC_SET_ARG1(*call, (ipcarg_t) dst);
    IPC_SET_ARG3(*call, (ipcarg_t) size);
    return ipc_answer(callid, call);
}
 
/** @}
 */
 

Rev 2615	Rev 2618
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 libc	29	/** @addtogroup libc
30	* @{	30	* @{
31	* @}	31	* @}
32	*/	32	*/
33		33
34	/** @addtogroup libcipc IPC	34	/** @addtogroup libcipc IPC
35	* @brief HelenOS uspace IPC	35	* @brief HelenOS uspace IPC
36	* @{	36	* @{
37	* @ingroup libc	37	* @ingroup libc
38	*/	38	*/
39	/** @file	39	/** @file
40	*/	40	*/
41		41
42	#include <ipc/ipc.h>	42	#include <ipc/ipc.h>
43	#include <libc.h>	43	#include <libc.h>
44	#include <malloc.h>	44	#include <malloc.h>
45	#include <errno.h>	45	#include <errno.h>
46	#include <libadt/list.h>	46	#include <libadt/list.h>
47	#include <stdio.h>	47	#include <stdio.h>
48	#include <unistd.h>	48	#include <unistd.h>
49	#include <futex.h>	49	#include <futex.h>
50	#include <kernel/synch/synch.h>	50	#include <kernel/synch/synch.h>
51	#include <async.h>	51	#include <async.h>
52	#include <fibril.h>	52	#include <fibril.h>
53	#include <assert.h>	53	#include <assert.h>
54		54
55	/**	55	/**
56	* Structures of this type are used for keeping track of sent asynchronous calls	56	* Structures of this type are used for keeping track of sent asynchronous calls
57	* and queing unsent calls.	57	* and queing unsent calls.
58	*/	58	*/
59	typedef struct {	59	typedef struct {
60	link_t list;	60	link_t list;
61		61
62	ipc_async_callback_t callback;	62	ipc_async_callback_t callback;
63	void *private;	63	void *private;
64	union {	64	union {
65	ipc_callid_t callid;	65	ipc_callid_t callid;
66	struct {	66	struct {
67	ipc_call_t data;	67	ipc_call_t data;
68	int phoneid;	68	int phoneid;
69	} msg;	69	} msg;
70	} u;	70	} u;
71	fid_t fid; /*< Fibril waiting for sending this call. /	71	fid_t fid; /*< Fibril waiting for sending this call. /
72	} async_call_t;	72	} async_call_t;
73		73
74	LIST_INITIALIZE(dispatched_calls);	74	LIST_INITIALIZE(dispatched_calls);
75		75
76	/** List of asynchronous calls that were not accepted by kernel.	76	/** List of asynchronous calls that were not accepted by kernel.
77	*	77	*
78	* It is protected by async_futex, because if the call cannot be sent into the	78	* It is protected by async_futex, because if the call cannot be sent into the
79	* kernel, the async framework is used automatically.	79	* kernel, the async framework is used automatically.
80	*/	80	*/
81	LIST_INITIALIZE(queued_calls);	81	LIST_INITIALIZE(queued_calls);
82		82
83	static atomic_t ipc_futex = FUTEX_INITIALIZER;	83	static atomic_t ipc_futex = FUTEX_INITIALIZER;
84		84
85	/** Make a fast synchronous call.	85	/** Make a fast synchronous call.
86	*	86	*
87	* Only three payload arguments can be passed using this function. However, this	87	* Only three payload arguments can be passed using this function. However, this
88	* function is faster than the generic ipc_call_sync_slow() because the payload	88	* function is faster than the generic ipc_call_sync_slow() because the payload
89	* is passed directly in registers.	89	* is passed directly in registers.
90	*	90	*
91	* @param phoneid Phone handle for the call.	91	* @param phoneid Phone handle for the call.
92	* @param method Requested method.	92	* @param method Requested method.
93	* @param arg1 Service-defined payload argument.	93	* @param arg1 Service-defined payload argument.
94	* @param arg2 Service-defined payload argument.	94	* @param arg2 Service-defined payload argument.
95	* @param arg3 Service-defined payload argument.	95	* @param arg3 Service-defined payload argument.
96	* @param result1 If non-NULL, the return ARG1 will be stored there.	96	* @param result1 If non-NULL, the return ARG1 will be stored there.
97	* @param result2 If non-NULL, the return ARG2 will be stored there.	97	* @param result2 If non-NULL, the return ARG2 will be stored there.
98	* @param result3 If non-NULL, the return ARG3 will be stored there.	98	* @param result3 If non-NULL, the return ARG3 will be stored there.
99	* @param result4 If non-NULL, the return ARG4 will be stored there.	99	* @param result4 If non-NULL, the return ARG4 will be stored there.
100	* @param result5 If non-NULL, the return ARG5 will be stored there.	100	* @param result5 If non-NULL, the return ARG5 will be stored there.
101	*	101	*
102	* @return Negative values represent errors returned by IPC.	102	* @return Negative values represent errors returned by IPC.
103	* Otherwise the RETVAL of the answer is returned.	103	* Otherwise the RETVAL of the answer is returned.
104	*/	104	*/
105	int	105	int
106	ipc_call_sync_fast(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,	106	ipc_call_sync_fast(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,
107	ipcarg_t arg3, ipcarg_t result1, ipcarg_t result2, ipcarg_t *result3,	107	ipcarg_t arg3, ipcarg_t result1, ipcarg_t result2, ipcarg_t *result3,
108	ipcarg_t result4, ipcarg_t result5)	108	ipcarg_t result4, ipcarg_t result5)
109	{	109	{
110	ipc_call_t resdata;	110	ipc_call_t resdata;
111	int callres;	111	int callres;
112		112
113	callres = __SYSCALL6(SYS_IPC_CALL_SYNC_FAST, phoneid, method, arg1,	113	callres = __SYSCALL6(SYS_IPC_CALL_SYNC_FAST, phoneid, method, arg1,
114	arg2, arg3, (sysarg_t) &resdata);	114	arg2, arg3, (sysarg_t) &resdata);
115	if (callres)	115	if (callres)
116	return callres;	116	return callres;
117	if (result1)	117	if (result1)
118	*result1 = IPC_GET_ARG1(resdata);	118	*result1 = IPC_GET_ARG1(resdata);
119	if (result2)	119	if (result2)
120	*result2 = IPC_GET_ARG2(resdata);	120	*result2 = IPC_GET_ARG2(resdata);
121	if (result3)	121	if (result3)
122	*result3 = IPC_GET_ARG3(resdata);	122	*result3 = IPC_GET_ARG3(resdata);
123	if (result4)	123	if (result4)
124	*result4 = IPC_GET_ARG4(resdata);	124	*result4 = IPC_GET_ARG4(resdata);
125	if (result5)	125	if (result5)
126	*result5 = IPC_GET_ARG5(resdata);	126	*result5 = IPC_GET_ARG5(resdata);
127		127
128	return IPC_GET_RETVAL(resdata);	128	return IPC_GET_RETVAL(resdata);
129	}	129	}
130		130
131	/** Make a synchronous call transmitting 5 arguments of payload.	131	/** Make a synchronous call transmitting 5 arguments of payload.
132	*	132	*
133	* @param phoneid Phone handle for the call.	133	* @param phoneid Phone handle for the call.
134	* @param method Requested method.	134	* @param method Requested method.
135	* @param arg1 Service-defined payload argument.	135	* @param arg1 Service-defined payload argument.
136	* @param arg2 Service-defined payload argument.	136	* @param arg2 Service-defined payload argument.
137	* @param arg3 Service-defined payload argument.	137	* @param arg3 Service-defined payload argument.
138	* @param arg4 Service-defined payload argument.	138	* @param arg4 Service-defined payload argument.
139	* @param arg5 Service-defined payload argument.	139	* @param arg5 Service-defined payload argument.
140	* @param result1 If non-NULL, storage for the first return argument.	140	* @param result1 If non-NULL, storage for the first return argument.
141	* @param result2 If non-NULL, storage for the second return argument.	141	* @param result2 If non-NULL, storage for the second return argument.
142	* @param result3 If non-NULL, storage for the third return argument.	142	* @param result3 If non-NULL, storage for the third return argument.
143	* @param result4 If non-NULL, storage for the fourth return argument.	143	* @param result4 If non-NULL, storage for the fourth return argument.
144	* @param result5 If non-NULL, storage for the fifth return argument.	144	* @param result5 If non-NULL, storage for the fifth return argument.
145	*	145	*
146	* @return Negative value means IPC error.	146	* @return Negative value means IPC error.
147	* Otherwise the RETVAL of the answer.	147	* Otherwise the RETVAL of the answer.
148	*/	148	*/
149	int	149	int
150	ipc_call_sync_slow(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,	150	ipc_call_sync_slow(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,
151	ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, ipcarg_t *result1,	151	ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, ipcarg_t *result1,
152	ipcarg_t result2, ipcarg_t result3, ipcarg_t result4, ipcarg_t result5)	152	ipcarg_t result2, ipcarg_t result3, ipcarg_t result4, ipcarg_t result5)
153	{	153	{
154	ipc_call_t data;	154	ipc_call_t data;
155	int callres;	155	int callres;
156		156
157	IPC_SET_METHOD(data, method);	157	IPC_SET_METHOD(data, method);
158	IPC_SET_ARG1(data, arg1);	158	IPC_SET_ARG1(data, arg1);
159	IPC_SET_ARG2(data, arg2);	159	IPC_SET_ARG2(data, arg2);
160	IPC_SET_ARG3(data, arg3);	160	IPC_SET_ARG3(data, arg3);
161	IPC_SET_ARG4(data, arg4);	161	IPC_SET_ARG4(data, arg4);
162	IPC_SET_ARG5(data, arg5);	162	IPC_SET_ARG5(data, arg5);
163		163
164	callres = __SYSCALL3(SYS_IPC_CALL_SYNC_SLOW, phoneid, (sysarg_t) &data,	164	callres = __SYSCALL3(SYS_IPC_CALL_SYNC_SLOW, phoneid, (sysarg_t) &data,
165	(sysarg_t) &data);	165	(sysarg_t) &data);
166	if (callres)	166	if (callres)
167	return callres;	167	return callres;
168		168
169	if (result1)	169	if (result1)
170	*result1 = IPC_GET_ARG1(data);	170	*result1 = IPC_GET_ARG1(data);
171	if (result2)	171	if (result2)
172	*result2 = IPC_GET_ARG2(data);	172	*result2 = IPC_GET_ARG2(data);
173	if (result3)	173	if (result3)
174	*result3 = IPC_GET_ARG3(data);	174	*result3 = IPC_GET_ARG3(data);
175	if (result4)	175	if (result4)
176	*result4 = IPC_GET_ARG4(data);	176	*result4 = IPC_GET_ARG4(data);
177	if (result5)	177	if (result5)
178	*result5 = IPC_GET_ARG5(data);	178	*result5 = IPC_GET_ARG5(data);
179		179
180	return IPC_GET_RETVAL(data);	180	return IPC_GET_RETVAL(data);
181	}	181	}
182		182
183	/** Syscall to send asynchronous message.	183	/** Syscall to send asynchronous message.
184	*	184	*
185	* @param phoneid Phone handle for the call.	185	* @param phoneid Phone handle for the call.
186	* @param data Call data with the request.	186	* @param data Call data with the request.
187	*	187	*
188	* @return Hash of the call or an error code.	188	* @return Hash of the call or an error code.
189	*/	189	*/
190	static ipc_callid_t _ipc_call_async(int phoneid, ipc_call_t *data)	190	static ipc_callid_t _ipc_call_async(int phoneid, ipc_call_t *data)
191	{	191	{
192	return __SYSCALL2(SYS_IPC_CALL_ASYNC, phoneid, (sysarg_t) data);	192	return __SYSCALL2(SYS_IPC_CALL_ASYNC_SLOW, phoneid, (sysarg_t) data);
193	}	193	}
194		194
195	/** Prolog to ipc_call_async_*() functions.	195	/** Prolog to ipc_call_async_*() functions.
196	*	196	*
197	* @param private Argument for the answer/error callback.	197	* @param private Argument for the answer/error callback.
198	* @param callback Answer/error callback.	198	* @param callback Answer/error callback.
199	*	199	*
200	* @return New, partially initialized async_call structure or NULL.	200	* @return New, partially initialized async_call structure or NULL.
201	*/	201	*/
202	static inline async_call_t ipc_prepare_async(void private,	202	static inline async_call_t ipc_prepare_async(void private,
203	ipc_async_callback_t callback)	203	ipc_async_callback_t callback)
204	{	204	{
205	async_call_t *call;	205	async_call_t *call;
206		206
207	call = malloc(sizeof(*call));	207	call = malloc(sizeof(*call));
208	if (!call) {	208	if (!call) {
209	if (callback)	209	if (callback)
210	callback(private, ENOMEM, NULL);	210	callback(private, ENOMEM, NULL);
211	return NULL;	211	return NULL;
212	}	212	}
213	call->callback = callback;	213	call->callback = callback;
214	call->private = private;	214	call->private = private;
215		215
216	return call;	216	return call;
217	}	217	}
218		218
219	/** Epilogue of ipc_call_async_*() functions.	219	/** Epilogue of ipc_call_async_*() functions.
220	*	220	*
221	* @param callid Value returned by the SYS_IPC_CALL_ASYNC_* syscall.	221	* @param callid Value returned by the SYS_IPC_CALL_ASYNC_* syscall.
222	* @param phoneid Phone handle through which the call was made.	222	* @param phoneid Phone handle through which the call was made.
223	* @param call async_call structure returned by ipc_prepare_async().	223	* @param call async_call structure returned by ipc_prepare_async().
224	* @param can_preempt If non-zero, the current fibril can be preempted in this	224	* @param can_preempt If non-zero, the current fibril can be preempted in this
225	* call.	225	* call.
226	*/	226	*/
227	static inline void ipc_finish_async(ipc_callid_t callid, int phoneid,	227	static inline void ipc_finish_async(ipc_callid_t callid, int phoneid,
228	async_call_t *call, int can_preempt)	228	async_call_t *call, int can_preempt)
229	{	229	{
230	if (!call) { /* Nothing to do regardless if failed or not */	230	if (!call) { /* Nothing to do regardless if failed or not */
231	futex_up(&ipc_futex);	231	futex_up(&ipc_futex);
232	return;	232	return;
233	}	233	}
234		234
235	if (callid == IPC_CALLRET_FATAL) {	235	if (callid == IPC_CALLRET_FATAL) {
236	futex_up(&ipc_futex);	236	futex_up(&ipc_futex);
237	/* Call asynchronous handler with error code */	237	/* Call asynchronous handler with error code */
238	if (call->callback)	238	if (call->callback)
239	call->callback(call->private, ENOENT, NULL);	239	call->callback(call->private, ENOENT, NULL);
240	free(call);	240	free(call);
241	return;	241	return;
242	}	242	}
243		243
244	if (callid == IPC_CALLRET_TEMPORARY) {	244	if (callid == IPC_CALLRET_TEMPORARY) {
245	futex_up(&ipc_futex);	245	futex_up(&ipc_futex);
246		246
247	call->u.msg.phoneid = phoneid;	247	call->u.msg.phoneid = phoneid;
248		248
249	futex_down(&async_futex);	249	futex_down(&async_futex);
250	list_append(&call->list, &queued_calls);	250	list_append(&call->list, &queued_calls);
251		251
252	if (can_preempt) {	252	if (can_preempt) {
253	call->fid = fibril_get_id();	253	call->fid = fibril_get_id();
254	fibril_switch(FIBRIL_TO_MANAGER);	254	fibril_switch(FIBRIL_TO_MANAGER);
255	/* Async futex unlocked by previous call */	255	/* Async futex unlocked by previous call */
256	} else {	256	} else {
257	call->fid = 0;	257	call->fid = 0;
258	futex_up(&async_futex);	258	futex_up(&async_futex);
259	}	259	}
260	return;	260	return;
261	}	261	}
262	call->u.callid = callid;	262	call->u.callid = callid;
263	/* Add call to the list of dispatched calls */	263	/* Add call to the list of dispatched calls */
264	list_append(&call->list, &dispatched_calls);	264	list_append(&call->list, &dispatched_calls);
265	futex_up(&ipc_futex);	265	futex_up(&ipc_futex);
266		266
267	}	267	}
268		268
269	/** Make a fast asynchronous call.	269	/** Make a fast asynchronous call.
270	*	270	*
271	* This function can only handle two arguments of payload. It is, however,	271	* This function can only handle four arguments of payload. It is, however,
272	* faster than the more generic ipc_call_async_3().	272	* faster than the more generic ipc_call_async_slow().
273	*	273	*
274	* Note that this function is a void function.	274	* Note that this function is a void function.
275	* During normal opertation, answering this call will trigger the callback.	275	* During normal opertation, answering this call will trigger the callback.
276	* In case of fatal error, call the callback handler with the proper error code.	276	* In case of fatal error, call the callback handler with the proper error code.
277	* If the call cannot be temporarily made, queue it.	277	* If the call cannot be temporarily made, queue it.
278	*	278	*
279	* @param phoneid Phone handle for the call.	279	* @param phoneid Phone handle for the call.
280	* @param method Requested method.	280	* @param method Requested method.
281	* @param arg1 Service-defined payload argument.	281	* @param arg1 Service-defined payload argument.
282	* @param arg2 Service-defined payload argument.	282	* @param arg2 Service-defined payload argument.
-		283	* @param arg3 Service-defined payload argument.
-		284	* @param arg4 Service-defined payload argument.
283	* @param private Argument to be passed to the answer/error callback.	285	* @param private Argument to be passed to the answer/error callback.
284	* @param callback Answer or error callback.	286	* @param callback Answer or error callback.
285	* @param can_preempt If non-zero, the current fibril will be preempted in	287	* @param can_preempt If non-zero, the current fibril will be preempted in
286	* case the kernel temporarily refuses to accept more	288	* case the kernel temporarily refuses to accept more
287	* asynchronous calls.	289	* asynchronous calls.
288	*/	290	*/
289	void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,	291	void ipc_call_async_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
290	ipcarg_t arg2, void *private, ipc_async_callback_t callback,	292	ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, void *private,
291	int can_preempt)	293	ipc_async_callback_t callback, int can_preempt)
292	{	294	{
293	async_call_t *call = NULL;	295	async_call_t *call = NULL;
294	ipc_callid_t callid;	296	ipc_callid_t callid;
295		297
296	if (callback) {	298	if (callback) {
297	call = ipc_prepare_async(private, callback);	299	call = ipc_prepare_async(private, callback);
298	if (!call)	300	if (!call)
299	return;	301	return;
300	}	302	}
301		303
302	/*	304	/*
303	* We need to make sure that we get callid before another thread	305	* We need to make sure that we get callid before another thread
304	* accesses the queue again.	306	* accesses the queue again.
305	*/	307	*/
306	futex_down(&ipc_futex);	308	futex_down(&ipc_futex);
307	callid = __SYSCALL4(SYS_IPC_CALL_ASYNC_FAST, phoneid, method, arg1,	309	callid = __SYSCALL6(SYS_IPC_CALL_ASYNC_FAST, phoneid, method, arg1,
308	arg2);	310	arg2, arg3, arg4);
309		311
310	if (callid == IPC_CALLRET_TEMPORARY) {	312	if (callid == IPC_CALLRET_TEMPORARY) {
311	if (!call) {	313	if (!call) {
312	call = ipc_prepare_async(private, callback);	314	call = ipc_prepare_async(private, callback);
313	if (!call)	315	if (!call)
314	return;	316	return;
315	}	317	}
316	IPC_SET_METHOD(call->u.msg.data, method);	318	IPC_SET_METHOD(call->u.msg.data, method);
317	IPC_SET_ARG1(call->u.msg.data, arg1);	319	IPC_SET_ARG1(call->u.msg.data, arg1);
318	IPC_SET_ARG2(call->u.msg.data, arg2);	320	IPC_SET_ARG2(call->u.msg.data, arg2);
-		321	IPC_SET_ARG3(call->u.msg.data, arg3);
-		322	IPC_SET_ARG4(call->u.msg.data, arg4);
319	}	323	}
320	ipc_finish_async(callid, phoneid, call, can_preempt);	324	ipc_finish_async(callid, phoneid, call, can_preempt);
321	}	325	}
322		326
323	/** Make an asynchronous call transmitting the entire payload.	327	/** Make an asynchronous call transmitting the entire payload.
324	*	328	*
325	* Note that this function is a void function.	329	* Note that this function is a void function.
326	* During normal opertation, answering this call will trigger the callback.	330	* During normal opertation, answering this call will trigger the callback.
327	* In case of fatal error, call the callback handler with the proper error code.	331	* In case of fatal error, call the callback handler with the proper error code.
328	* If the call cannot be temporarily made, queue it.	332	* If the call cannot be temporarily made, queue it.
329	*	333	*
330	* @param phoneid Phone handle for the call.	334	* @param phoneid Phone handle for the call.
331	* @param method Requested method.	335	* @param method Requested method.
332	* @param arg1 Service-defined payload argument.	336	* @param arg1 Service-defined payload argument.
333	* @param arg2 Service-defined payload argument.	337	* @param arg2 Service-defined payload argument.
334	* @param arg3 Service-defined payload argument.	338	* @param arg3 Service-defined payload argument.
-		339	* @param arg4 Service-defined payload argument.
-		340	* @param arg5 Service-defined payload argument.
335	* @param private Argument to be passed to the answer/error callback.	341	* @param private Argument to be passed to the answer/error callback.
336	* @param callback Answer or error callback.	342	* @param callback Answer or error callback.
337	* @param can_preempt If non-zero, the current fibril will be preempted in	343	* @param can_preempt If non-zero, the current fibril will be preempted in
338	* case the kernel temporarily refuses to accept more	344	* case the kernel temporarily refuses to accept more
339	* asynchronous calls.	345	* asynchronous calls.
340	*	346	*
341	*/	347	*/
342	void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,	348	void ipc_call_async_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
343	ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,	349	ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, void *private,
344	int can_preempt)	350	ipc_async_callback_t callback, int can_preempt)
345	{	351	{
346	async_call_t *call;	352	async_call_t *call;
347	ipc_callid_t callid;	353	ipc_callid_t callid;
348		354
349	call = ipc_prepare_async(private, callback);	355	call = ipc_prepare_async(private, callback);
350	if (!call)	356	if (!call)
351	return;	357	return;
352		358
353	IPC_SET_METHOD(call->u.msg.data, method);	359	IPC_SET_METHOD(call->u.msg.data, method);
354	IPC_SET_ARG1(call->u.msg.data, arg1);	360	IPC_SET_ARG1(call->u.msg.data, arg1);
355	IPC_SET_ARG2(call->u.msg.data, arg2);	361	IPC_SET_ARG2(call->u.msg.data, arg2);
356	IPC_SET_ARG3(call->u.msg.data, arg3);	362	IPC_SET_ARG3(call->u.msg.data, arg3);
-		363	IPC_SET_ARG4(call->u.msg.data, arg4);
-		364	IPC_SET_ARG5(call->u.msg.data, arg5);
357	/*	365	/*
358	* We need to make sure that we get callid before another thread accesses	366	* We need to make sure that we get callid before another thread
359	* the queue again.	367	* accesses the queue again.
360	*/	368	*/
361	futex_down(&ipc_futex);	369	futex_down(&ipc_futex);
362	callid = _ipc_call_async(phoneid, &call->u.msg.data);	370	callid = _ipc_call_async(phoneid, &call->u.msg.data);
363		371
364	ipc_finish_async(callid, phoneid, call, can_preempt);	372	ipc_finish_async(callid, phoneid, call, can_preempt);
365	}	373	}
366		374
367		375
368	/** Answer a received call - fast version.	376	/** Answer a received call - fast version.
369	*	377	*
370	* The fast answer makes use of passing retval and first two arguments in	378	* The fast answer makes use of passing retval and first two arguments in
371	* registers. If you need to return more, use the ipc_answer() instead.	379	* registers. If you need to return more, use the ipc_answer() instead.
372	*	380	*
373	* @param callid Hash of the call being answered.	381	* @param callid Hash of the call being answered.
374	* @param retval Return value.	382	* @param retval Return value.
375	* @param arg1 First return argument.	383	* @param arg1 First return argument.
376	* @param arg2 Second return argument.	384	* @param arg2 Second return argument.
377	*	385	*
378	* @return Zero on success or a value from @ref errno.h on failure.	386	* @return Zero on success or a value from @ref errno.h on failure.
379	*/	387	*/
380	ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1,	388	ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1,
381	ipcarg_t arg2)	389	ipcarg_t arg2)
382	{	390	{
383	return __SYSCALL4(SYS_IPC_ANSWER_FAST, callid, retval, arg1, arg2);	391	return __SYSCALL4(SYS_IPC_ANSWER_FAST, callid, retval, arg1, arg2);
384	}	392	}
385		393
386	/** Answer a received call - full version.	394	/** Answer a received call - full version.
387	*	395	*
388	* @param callid Hash of the call being answered.	396	* @param callid Hash of the call being answered.
389	* @param call Call structure with the answer.	397	* @param call Call structure with the answer.
390	* Must be already initialized by the responder.	398	* Must be already initialized by the responder.
391	*	399	*
392	* @return Zero on success or a value from @ref errno.h on failure.	400	* @return Zero on success or a value from @ref errno.h on failure.
393	*/	401	*/
394	ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call)	402	ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call)
395	{	403	{
396	return __SYSCALL2(SYS_IPC_ANSWER, callid, (sysarg_t) call);	404	return __SYSCALL2(SYS_IPC_ANSWER, callid, (sysarg_t) call);
397	}	405	}
398		406
399		407
400	/** Try to dispatch queued calls from the async queue. */	408	/** Try to dispatch queued calls from the async queue. */
401	static void try_dispatch_queued_calls(void)	409	static void try_dispatch_queued_calls(void)
402	{	410	{
403	async_call_t *call;	411	async_call_t *call;
404	ipc_callid_t callid;	412	ipc_callid_t callid;
405		413
406	/** @todo	414	/** @todo
407	* Integrate intelligently ipc_futex, so that it is locked during	415	* Integrate intelligently ipc_futex, so that it is locked during
408	* ipc_call_async_*(), until it is added to dispatched_calls.	416	* ipc_call_async_*(), until it is added to dispatched_calls.
409	*/	417	*/
410	futex_down(&async_futex);	418	futex_down(&async_futex);
411	while (!list_empty(&queued_calls)) {	419	while (!list_empty(&queued_calls)) {
412	call = list_get_instance(queued_calls.next, async_call_t, list);	420	call = list_get_instance(queued_calls.next, async_call_t, list);
413	callid = _ipc_call_async(call->u.msg.phoneid, &call->u.msg.data);	421	callid = _ipc_call_async(call->u.msg.phoneid, &call->u.msg.data);
414	if (callid == IPC_CALLRET_TEMPORARY) {	422	if (callid == IPC_CALLRET_TEMPORARY) {
415	break;	423	break;
416	}	424	}
417	list_remove(&call->list);	425	list_remove(&call->list);
418		426
419	futex_up(&async_futex);	427	futex_up(&async_futex);
420	if (call->fid)	428	if (call->fid)
421	fibril_add_ready(call->fid);	429	fibril_add_ready(call->fid);
422		430
423	if (callid == IPC_CALLRET_FATAL) {	431	if (callid == IPC_CALLRET_FATAL) {
424	if (call->callback)	432	if (call->callback)
425	call->callback(call->private, ENOENT, NULL);	433	call->callback(call->private, ENOENT, NULL);
426	free(call);	434	free(call);
427	} else {	435	} else {
428	call->u.callid = callid;	436	call->u.callid = callid;
429	futex_down(&ipc_futex);	437	futex_down(&ipc_futex);
430	list_append(&call->list, &dispatched_calls);	438	list_append(&call->list, &dispatched_calls);
431	futex_up(&ipc_futex);	439	futex_up(&ipc_futex);
432	}	440	}
433	futex_down(&async_futex);	441	futex_down(&async_futex);
434	}	442	}
435	futex_up(&async_futex);	443	futex_up(&async_futex);
436	}	444	}
437		445
438	/** Handle a received answer.	446	/** Handle a received answer.
439	*	447	*
440	* Find the hash of the answer and call the answer callback.	448	* Find the hash of the answer and call the answer callback.
441	*	449	*
442	* @todo Make it use hash table.	450	* @todo Make it use hash table.
443	*	451	*
444	* @param callid Hash of the received answer.	452	* @param callid Hash of the received answer.
445	* The answer has the same hash as the request OR'ed with	453	* The answer has the same hash as the request OR'ed with
446	* the IPC_CALLID_ANSWERED bit.	454	* the IPC_CALLID_ANSWERED bit.
447	* @param data Call data of the answer.	455	* @param data Call data of the answer.
448	*/	456	*/
449	static void handle_answer(ipc_callid_t callid, ipc_call_t *data)	457	static void handle_answer(ipc_callid_t callid, ipc_call_t *data)
450	{	458	{
451	link_t *item;	459	link_t *item;
452	async_call_t *call;	460	async_call_t *call;
453		461
454	callid &= ~IPC_CALLID_ANSWERED;	462	callid &= ~IPC_CALLID_ANSWERED;
455		463
456	futex_down(&ipc_futex);	464	futex_down(&ipc_futex);
457	for (item = dispatched_calls.next; item != &dispatched_calls;	465	for (item = dispatched_calls.next; item != &dispatched_calls;
458	item = item->next) {	466	item = item->next) {
459	call = list_get_instance(item, async_call_t, list);	467	call = list_get_instance(item, async_call_t, list);
460	if (call->u.callid == callid) {	468	if (call->u.callid == callid) {
461	list_remove(&call->list);	469	list_remove(&call->list);
462	futex_up(&ipc_futex);	470	futex_up(&ipc_futex);
463	if (call->callback)	471	if (call->callback)
464	call->callback(call->private,	472	call->callback(call->private,
465	IPC_GET_RETVAL(*data), data);	473	IPC_GET_RETVAL(*data), data);
466	free(call);	474	free(call);
467	return;	475	return;
468	}	476	}
469	}	477	}
470	futex_up(&ipc_futex);	478	futex_up(&ipc_futex);
471	}	479	}
472		480
473		481
474	/** Wait for a first call to come.	482	/** Wait for a first call to come.
475	*	483	*
476	* @param call Storage where the incoming call data will be stored.	484	* @param call Storage where the incoming call data will be stored.
477	* @param usec Timeout in microseconds	485	* @param usec Timeout in microseconds
478	* @param flags Flags passed to SYS_IPC_WAIT (blocking, nonblocking).	486	* @param flags Flags passed to SYS_IPC_WAIT (blocking, nonblocking).
479	*	487	*
480	* @return Hash of the call. Note that certain bits have special	488	* @return Hash of the call. Note that certain bits have special
481	* meaning. IPC_CALLID_ANSWERED will be set in an answer	489	* meaning. IPC_CALLID_ANSWERED will be set in an answer
482	* and IPC_CALLID_NOTIFICATION is used for notifications.	490	* and IPC_CALLID_NOTIFICATION is used for notifications.
483	*	491	*
484	*/	492	*/
485	ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags)	493	ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags)
486	{	494	{
487	ipc_callid_t callid;	495	ipc_callid_t callid;
488		496
489	callid = __SYSCALL3(SYS_IPC_WAIT, (sysarg_t) call, usec, flags);	497	callid = __SYSCALL3(SYS_IPC_WAIT, (sysarg_t) call, usec, flags);
490	/* Handle received answers */	498	/* Handle received answers */
491	if (callid & IPC_CALLID_ANSWERED) {	499	if (callid & IPC_CALLID_ANSWERED) {
492	handle_answer(callid, call);	500	handle_answer(callid, call);

Subversion Repositories HelenOS

(root)/trunk/uspace/lib/libc/generic/ipc.c – Rev 2615 → 2618