WebSVN – HelenOS – Diff – /trunk/uspace/lib/libc/generic/async.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
 * @{
 */
/** @file
 */
 
/**
 * Asynchronous library
 *
 * The aim of this library is to provide a facility for writing programs which
 * utilize the asynchronous nature of HelenOS IPC, yet using a normal way of
 * programming.
 *
 * You should be able to write very simple multithreaded programs, the async
 * framework will automatically take care of most synchronization problems.
 *
 * Default semantics:
 * - async_send_*(): Send asynchronously. If the kernel refuses to send
 *                   more messages, [ try to get responses from kernel, if
 *                   nothing found, might try synchronous ]
 *
 * Example of use (pseudo C):
 *
 * 1) Multithreaded client application
 *
 *   fibril_create(fibril1, ...);
 *   fibril_create(fibril2, ...);
 *   ...
 *
 *   int fibril1(void *arg)
 *   {
 *     conn = ipc_connect_me_to();
 *     c1 = async_send(conn);
 *     c2 = async_send(conn);
 *     async_wait_for(c1);
 *     async_wait_for(c2);
 *     ...
 *   }
 *
 *
 * 2) Multithreaded server application
 *
 *   main()
 *   {
 *     async_manager();
 *   }
 *
 *   my_client_connection(icallid, *icall)
 *   {
 *     if (want_refuse) {
 *       ipc_answer_0(icallid, ELIMIT);
 *       return;
 *     }
 *     ipc_answer_0(icallid, EOK);
 *
 *     callid = async_get_call(&call);
 *     handle_call(callid, call);
 *     ipc_answer_2(callid, 1, 2, 3);
 *
 *     callid = async_get_call(&call);
 *     ...
 *   }
 *
 */
 
#include <futex.h>
#include <async.h>
#include <fibril.h>
#include <stdio.h>
#include <adt/hash_table.h>
#include <adt/list.h>
#include <ipc/ipc.h>
#include <assert.h>
#include <errno.h>
#include <sys/time.h>
#include <arch/barrier.h>
#include <bool.h>
 
atomic_t async_futex = FUTEX_INITIALIZER;
 
/** Structures of this type represent a waiting fibril. */
typedef struct {
    /** Expiration time. */
    struct timeval expires;
   
    /** If true, this struct is in the timeout list. */
    bool inlist;
   
    /** Timeout list link. */
    link_t link;
   
    /** Identification of and link to the waiting fibril. */
    fid_t fid;
   
    /** If true, this fibril is currently active. */
    bool active;
   
    /** If true, we have timed out. */
    bool timedout;
} awaiter_t;
 
typedef struct {
    awaiter_t wdata;
   
    /** If reply was received. */
    bool done;
   
    /** Pointer to where the answer data is stored. */
    ipc_call_t *dataptr;
   
    ipcarg_t retval;
} amsg_t;
 
/**
 * Structures of this type are used to group information about a call and a
 * message queue link.
 */
typedef struct {
    link_t link;
    ipc_callid_t callid;
    ipc_call_t call;
} msg_t;
 
typedef struct {
    awaiter_t wdata;
   
    /** Hash table link. */
    link_t link;
   
    /** Incoming phone hash. */
    ipcarg_t in_phone_hash;
   
    /** Messages that should be delivered to this fibril. */
    link_t msg_queue;
   
    /** Identification of the opening call. */
    ipc_callid_t callid;
    /** Call data of the opening call. */
    ipc_call_t call;
   
    /** Identification of the closing call. */
    ipc_callid_t close_callid;
   
    /** Fibril function that will be used to handle the connection. */
    void (*cfibril)(ipc_callid_t, ipc_call_t *);
} connection_t;
 
/** Identifier of the incoming connection handled by the current fibril. */
__thread connection_t *FIBRIL_connection;
 
static void default_client_connection(ipc_callid_t callid, ipc_call_t *call);
static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call);
static void default_pending(void);
 
/**
 * Pointer to a fibril function that will be used to handle connections.
 */
static async_client_conn_t client_connection = default_client_connection;
 
/**
 * Pointer to a fibril function that will be used to handle interrupt
 * notifications.
 */
static async_client_conn_t interrupt_received = default_interrupt_received;
 
/**
 * Pointer to a fibril function that will be used to handle pending
 * operations.
 */
static async_pending_t pending = default_pending;
 
static hash_table_t conn_hash_table;
static LIST_INITIALIZE(timeout_list);
 
#define CONN_HASH_TABLE_CHAINS  32
 
/** Compute hash into the connection hash table based on the source phone hash.
 *
 * @param key Pointer to source phone hash.
 *
 * @return Index into the connection hash table.
 *
 */
static hash_index_t conn_hash(unsigned long *key)
{
    assert(key);
    return (((*key) >> 4) % CONN_HASH_TABLE_CHAINS);
}
 
/** Compare hash table item with a key.
 *
 * @param key  Array containing the source phone hash as the only item.
 * @param keys Expected 1 but ignored.
 * @param item Connection hash table item.
 *
 * @return True on match, false otherwise.
 *
 */
static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)
{
    connection_t *hs = hash_table_get_instance(item, connection_t, link);
    return (key[0] == hs->in_phone_hash);
}
 
/** Connection hash table removal callback function.
 *
 * This function is called whenever a connection is removed from the connection
 * hash table.
 *
 * @param item Connection hash table item being removed.
 *
 */
static void conn_remove(link_t *item)
{
    free(hash_table_get_instance(item, connection_t, link));
}
 
 
/** Operations for the connection hash table. */
static hash_table_operations_t conn_hash_table_ops = {
    .hash = conn_hash,
    .compare = conn_compare,
    .remove_callback = conn_remove
};
 
/** Sort in current fibril's timeout request.
 *
 * @param wd Wait data of the current fibril.
 *
 */
static void insert_timeout(awaiter_t *wd)
{
    wd->timedout = false;
    wd->inlist = true;
   
    link_t *tmp = timeout_list.next;
    while (tmp != &timeout_list) {
        awaiter_t *cur = list_get_instance(tmp, awaiter_t, link);
       
        if (tv_gteq(&cur->expires, &wd->expires))
            break;
       
        tmp = tmp->next;
    }
   
    list_append(&wd->link, tmp);
}
 
/** Try to route a call to an appropriate connection fibril.
 *
 * If the proper connection fibril is found, a message with the call is added to
 * its message queue. If the fibril was not active, it is activated and all
 * timeouts are unregistered.
 *
 * @param callid Hash of the incoming call.
 * @param call   Data of the incoming call.
 *
 * @return False if the call doesn't match any connection.
 *         True if the call was passed to the respective connection fibril.
 *
 */
static bool route_call(ipc_callid_t callid, ipc_call_t *call)
{
    futex_down(&async_futex);
   
    unsigned long key = call->in_phone_hash;
    link_t *hlp = hash_table_find(&conn_hash_table, &key);
   
    if (!hlp) {
        futex_up(&async_futex);
        return false;
    }
   
    connection_t *conn = hash_table_get_instance(hlp, connection_t, link);
   
    msg_t *msg = malloc(sizeof(*msg));
    if (!msg) {
        futex_up(&async_futex);
        return false;
    }
   
    msg->callid = callid;
    msg->call = *call;
    list_append(&msg->link, &conn->msg_queue);
   
    if (IPC_GET_METHOD(*call) == IPC_M_PHONE_HUNGUP)
        conn->close_callid = callid;
   
    /* If the connection fibril is waiting for an event, activate it */
    if (!conn->wdata.active) {
       
        /* If in timeout list, remove it */
        if (conn->wdata.inlist) {
            conn->wdata.inlist = false;
            list_remove(&conn->wdata.link);
        }
       
        conn->wdata.active = true;
        fibril_add_ready(conn->wdata.fid);
    }
   
    futex_up(&async_futex);
    return true;
}
 
/** Notification fibril.
 *
 * When a notification arrives, a fibril with this implementing function is
 * created. It calls interrupt_received() and does the final cleanup.
 *
 * @param arg Message structure pointer.
 *
 * @return Always zero.
 *
 */
static int notification_fibril(void *arg)
{
    msg_t *msg = (msg_t *) arg;
    interrupt_received(msg->callid, &msg->call);
   
    free(msg);
    return 0;
}
 
/** Process interrupt notification.
 *
 * A new fibril is created which would process the notification.
 *
 * @param callid Hash of the incoming call.
 * @param call   Data of the incoming call.
 *
 * @return False if an error occured.
 *         True if the call was passed to the notification fibril.
 *
 */
static bool process_notification(ipc_callid_t callid, ipc_call_t *call)
{
    futex_down(&async_futex);
   
    msg_t *msg = malloc(sizeof(*msg));
    if (!msg) {
        futex_up(&async_futex);
        return false;
    }
   
    msg->callid = callid;
    msg->call = *call;
   
    fid_t fid = fibril_create(notification_fibril, msg);
    fibril_add_ready(fid);
   
    futex_up(&async_futex);
    return true;
}
 
/** Pending fibril.
 *
 * After each call the pending operations are executed in a separate
 * fibril. The function pending() is c.
 *
 * @param arg Unused.
 *
 * @return Always zero.
 *
 */
static int pending_fibril(void *arg)
{
    pending();
   
    return 0;
}
 
/** Process pending actions.
 *
 * A new fibril is created which would process the pending operations.
 *
 * @return False if an error occured.
 *         True if the execution was passed to the pending fibril.
 *
 */
static bool process_pending(void)
{
    futex_down(&async_futex);
   
    fid_t fid = fibril_create(pending_fibril, NULL);
    fibril_add_ready(fid);
   
    futex_up(&async_futex);
    return true;
}
 
/** Return new incoming message for the current (fibril-local) connection.
 *
 * @param call  Storage where the incoming call data will be stored.
 * @param usecs Timeout in microseconds. Zero denotes no timeout.
 *
 * @return If no timeout was specified, then a hash of the
 *         incoming call is returned. If a timeout is specified,
 *         then a hash of the incoming call is returned unless
 *         the timeout expires prior to receiving a message. In
 *         that case zero is returned.
 *
 */
ipc_callid_t async_get_call_timeout(ipc_call_t *call, suseconds_t usecs)
{
    assert(FIBRIL_connection);
   
    /* Why doing this?
     * GCC 4.1.0 coughs on FIBRIL_connection-> dereference.
     * GCC 4.1.1 happilly puts the rdhwr instruction in delay slot.
     *           I would never expect to find so many errors in
     *           a compiler.
     */
    connection_t *conn = FIBRIL_connection;
   
    futex_down(&async_futex);
   
    if (usecs) {
        gettimeofday(&conn->wdata.expires, NULL);
        tv_add(&conn->wdata.expires, usecs);
    } else
        conn->wdata.inlist = false;
   
    /* If nothing in queue, wait until something arrives */
    while (list_empty(&conn->msg_queue)) {
        if (usecs)
            insert_timeout(&conn->wdata);
       
        conn->wdata.active = false;
       
        /*
         * Note: the current fibril will be rescheduled either due to a
         * timeout or due to an arriving message destined to it. In the
         * former case, handle_expired_timeouts() and, in the latter
         * case, route_call() will perform the wakeup.
         */
        fibril_switch(FIBRIL_TO_MANAGER);
       
        /*
         * Futex is up after getting back from async_manager.
         * Get it again.
         */
        futex_down(&async_futex);
        if ((usecs) && (conn->wdata.timedout)
            && (list_empty(&conn->msg_queue))) {
            /* If we timed out -> exit */
            futex_up(&async_futex);
            return 0;
        }
    }
   
    msg_t *msg = list_get_instance(conn->msg_queue.next, msg_t, link);
    list_remove(&msg->link);
   
    ipc_callid_t callid = msg->callid;
    *call = msg->call;
    free(msg);
   
    futex_up(&async_futex);
    return callid;
}
 
/** Default fibril function that gets called to handle new connection.
 *
 * This function is defined as a weak symbol - to be redefined in user code.
 *
 * @param callid Hash of the incoming call.
 * @param call   Data of the incoming call.
 *
 */
static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)
{
    ipc_answer_0(callid, ENOENT);
}
 
/** Default fibril function that gets called to handle interrupt notifications.
 *
 * This function is defined as a weak symbol - to be redefined in user code.
 *
 * @param callid Hash of the incoming call.
 * @param call   Data of the incoming call.
 *
 */
static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call)
{
}
 
/** Default fibril function that gets called to handle pending operations.
 *
 * This function is defined as a weak symbol - to be redefined in user code.
 *
 */
static void default_pending(void)
{
}
 
/** Wrapper for client connection fibril.
 *
 * When a new connection arrives, a fibril with this implementing function is
 * created. It calls client_connection() and does the final cleanup.
 *
 * @param arg Connection structure pointer.
 *
 * @return Always zero.
 *
 */
static int connection_fibril(void *arg)
{
    /*
     * Setup fibril-local connection pointer and call client_connection().
     *
     */
    FIBRIL_connection = (connection_t *) arg;
    FIBRIL_connection->cfibril(FIBRIL_connection->callid,
        &FIBRIL_connection->call);
   
    /* Remove myself from the connection hash table */
    futex_down(&async_futex);
    unsigned long key = FIBRIL_connection->in_phone_hash;
    hash_table_remove(&conn_hash_table, &key, 1);
    futex_up(&async_futex);
   
    /* Answer all remaining messages with EHANGUP */
    while (!list_empty(&FIBRIL_connection->msg_queue)) {
        msg_t *msg
            = list_get_instance(FIBRIL_connection->msg_queue.next, msg_t, link);
       
        list_remove(&msg->link);
        ipc_answer_0(msg->callid, EHANGUP);
        free(msg);
    }
   
    if (FIBRIL_connection->close_callid)
        ipc_answer_0(FIBRIL_connection->close_callid, EOK);
   
    return 0;
}
 
/** Create a new fibril for a new connection.
 *
 * Create new fibril for connection, fill in connection structures and inserts
 * it into the hash table, so that later we can easily do routing of messages to
 * particular fibrils.
 *
 * @param in_phone_hash Identification of the incoming connection.
 * @param callid        Hash of the opening IPC_M_CONNECT_ME_TO call.
 *                      If callid is zero, the connection was opened by
 *                      accepting the IPC_M_CONNECT_TO_ME call and this function
 *                      is called directly by the server.
 * @param call          Call data of the opening call.
 * @param cfibril       Fibril function that should be called upon opening the
 *                      connection.
 *
 * @return New fibril id or NULL on failure.
 *
 */
fid_t async_new_connection(ipcarg_t in_phone_hash, ipc_callid_t callid,
    ipc_call_t *call, void (*cfibril)(ipc_callid_t, ipc_call_t *))
{
    connection_t *conn = malloc(sizeof(*conn));
    if (!conn) {
        if (callid)
            ipc_answer_0(callid, ENOMEM);
        return NULL;
    }
   
    conn->in_phone_hash = in_phone_hash;
    list_initialize(&conn->msg_queue);
    conn->callid = callid;
    conn->close_callid = false;
   
    if (call)
        conn->call = *call;
   
    /* We will activate the fibril ASAP */
    conn->wdata.active = true;
    conn->cfibril = cfibril;
    conn->wdata.fid = fibril_create(connection_fibril, conn);
   
    if (!conn->wdata.fid) {
        free(conn);
        if (callid)
            ipc_answer_0(callid, ENOMEM);
        return NULL;
    }
   
    /* Add connection to the connection hash table */
    unsigned long key = conn->in_phone_hash;
   
    futex_down(&async_futex);
    hash_table_insert(&conn_hash_table, &key, &conn->link);
    futex_up(&async_futex);
   
    fibril_add_ready(conn->wdata.fid);
   
    return conn->wdata.fid;
}
 
/** Handle a call that was received.
 *
 * If the call has the IPC_M_CONNECT_ME_TO method, a new connection is created.
 * Otherwise the call is routed to its connection fibril.
 *
 * @param callid Hash of the incoming call.
 * @param call   Data of the incoming call.
 *
 */
static void handle_call(ipc_callid_t callid, ipc_call_t *call)
{
    /* Unrouted call - do some default behaviour */
    if ((callid & IPC_CALLID_NOTIFICATION)) {
        process_notification(callid, call);
        goto out;
    }
   
    switch (IPC_GET_METHOD(*call)) {
    case IPC_M_CONNECT_ME:
    case IPC_M_CONNECT_ME_TO:
        /* Open new connection with fibril etc. */
        async_new_connection(IPC_GET_ARG5(*call), callid, call,
            client_connection);
        goto out;
    }
   
    /* Try to route the call through the connection hash table */
    if (route_call(callid, call))
        goto out;
   
    /* Unknown call from unknown phone - hang it up */
    ipc_answer_0(callid, EHANGUP);
    return;
   
out:
    process_pending();
}
 
/** Fire all timeouts that expired. */
static void handle_expired_timeouts(void)
{
    struct timeval tv;
    gettimeofday(&tv, NULL);
   
    futex_down(&async_futex);
   
    link_t *cur = timeout_list.next;
    while (cur != &timeout_list) {
        awaiter_t *waiter = list_get_instance(cur, awaiter_t, link);
       
        if (tv_gt(&waiter->expires, &tv))
            break;
       
        cur = cur->next;
       
        list_remove(&waiter->link);
        waiter->inlist = false;
        waiter->timedout = true;
       
        /*
         * Redundant condition?
         * The fibril should not be active when it gets here.
         */
        if (!waiter->active) {
            waiter->active = true;
            fibril_add_ready(waiter->fid);
        }
    }
   
    futex_up(&async_futex);
}
 
/** Endless loop dispatching incoming calls and answers.
 *
 * @return Never returns.
 *
 */
static int async_manager_worker(void)
{
    while (true) {
        if (fibril_switch(FIBRIL_FROM_MANAGER)) {
            futex_up(&async_futex);
            /*
             * async_futex is always held when entering a manager
             * fibril.
             */
            continue;
        }
       
        futex_down(&async_futex);
       
        suseconds_t timeout;
        if (!list_empty(&timeout_list)) {
            awaiter_t *waiter
                = list_get_instance(timeout_list.next, awaiter_t, link);
           
            struct timeval tv;
            gettimeofday(&tv, NULL);
           
            if (tv_gteq(&tv, &waiter->expires)) {
                futex_up(&async_futex);
                handle_expired_timeouts();
                continue;
            } else
                timeout = tv_sub(&waiter->expires, &tv);
        } else
            timeout = SYNCH_NO_TIMEOUT;
       
        futex_up(&async_futex);
       
        ipc_call_t call;
        ipc_callid_t callid
            = ipc_wait_cycle(&call, timeout, SYNCH_FLAGS_NONE);
       
        if (!callid) {
            handle_expired_timeouts();
            continue;
        }
       
        if (callid & IPC_CALLID_ANSWERED)
            continue;
       
        handle_call(callid, &call);
    }
   
    return 0;
}
 
/** Function to start async_manager as a standalone fibril.
 *
 * When more kernel threads are used, one async manager should exist per thread.
 *
 * @param arg Unused.
 * @return Never returns.
 *
 */
static int async_manager_fibril(void *arg)
{
    futex_up(&async_futex);
   
    /*
     * async_futex is always locked when entering manager
     */
    async_manager_worker();
   
    return 0;
}
 
/** Add one manager to manager list. */
void async_create_manager(void)
{
    fid_t fid = fibril_create(async_manager_fibril, NULL);
    fibril_add_manager(fid);
}
 
/** Remove one manager from manager list */
void async_destroy_manager(void)
{
    fibril_remove_manager();
}
 
/** Initialize the async framework.
 *
 * @return Zero on success or an error code.
 */
int _async_init(void)
{
    if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_CHAINS, 1,
        &conn_hash_table_ops)) {
        printf("%s: cannot create hash table\n", "async");
        return ENOMEM;
    }
   
    return 0;
}
 
/** Reply received callback.
 *
 * This function is called whenever a reply for an asynchronous message sent out
 * by the asynchronous framework is received.
 *
 * Notify the fibril which is waiting for this message that it has arrived.
 *
 * @param arg    Pointer to the asynchronous message record.
 * @param retval Value returned in the answer.
 * @param data   Call data of the answer.
 */
static void reply_received(void *arg, int retval, ipc_call_t *data)
{
    futex_down(&async_futex);
   
    amsg_t *msg = (amsg_t *) arg;
    msg->retval = retval;
   
    /* Copy data after futex_down, just in case the call was detached */
    if ((msg->dataptr) && (data))
        *msg->dataptr = *data;
   
    write_barrier();
   
    /* Remove message from timeout list */
    if (msg->wdata.inlist)
        list_remove(&msg->wdata.link);
   
    msg->done = true;
    if (!msg->wdata.active) {
        msg->wdata.active = true;
        fibril_add_ready(msg->wdata.fid);
    }
   
    futex_up(&async_futex);
}
 
/** Send message and return id of the sent message.
 *
 * The return value can be used as input for async_wait() to wait for
 * completion.
 *
 * @param phoneid Handle of the phone that will be used for the send.
 * @param method  Service-defined 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 dataptr If non-NULL, storage where the reply data will be
 *                stored.
 *
 * @return Hash of the sent message or 0 on error.
 *
 */
aid_t async_send_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipc_call_t *dataptr)
{
    amsg_t *msg = malloc(sizeof(*msg));
   
    if (!msg)
        return 0;
   
    msg->done = false;
    msg->dataptr = dataptr;
   
    msg->wdata.inlist = false;
    /* We may sleep in the next method, but it will use its own mechanism */
    msg->wdata.active = true;
   
    ipc_call_async_4(phoneid, method, arg1, arg2, arg3, arg4, msg,
        reply_received, true);
   
    return (aid_t) msg;
}
 
/** Send message and return id of the sent message
 *
 * The return value can be used as input for async_wait() to wait for
 * completion.
 *
 * @param phoneid Handle of the phone that will be used for the send.
 * @param method  Service-defined 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 dataptr If non-NULL, storage where the reply data will be
 *                stored.
 *
 * @return Hash of the sent message or 0 on error.
 *
 */
aid_t async_send_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5,
    ipc_call_t *dataptr)
{
    amsg_t *msg = malloc(sizeof(*msg));
   
    if (!msg)
        return 0;
   
    msg->done = false;
    msg->dataptr = dataptr;
   
    msg->wdata.inlist = false;
    /* We may sleep in next method, but it will use its own mechanism */
    msg->wdata.active = true;
   
    ipc_call_async_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, msg,
        reply_received, true);
   
    return (aid_t) msg;
}
 
/** Wait for a message sent by the async framework.
 *
 * @param amsgid Hash of the message to wait for.
 * @param retval Pointer to storage where the retval of the answer will
 *               be stored.
 *
 */
void async_wait_for(aid_t amsgid, ipcarg_t *retval)
{
    amsg_t *msg = (amsg_t *) amsgid;
   
    futex_down(&async_futex);
    if (msg->done) {
        futex_up(&async_futex);
        goto done;
    }
   
    msg->wdata.fid = fibril_get_id();
    msg->wdata.active = false;
    msg->wdata.inlist = false;
   
    /* Leave the async_futex locked when entering this function */
    fibril_switch(FIBRIL_TO_MANAGER);
   
    /* Futex is up automatically after fibril_switch */
   
done:
    if (retval)
        *retval = msg->retval;
   
    free(msg);
}
 
/** Wait for a message sent by the async framework, timeout variant.
 *
 * @param amsgid  Hash of the message to wait for.
 * @param retval  Pointer to storage where the retval of the answer will
 *                be stored.
 * @param timeout Timeout in microseconds.
 *
 * @return Zero on success, ETIMEOUT if the timeout has expired.
 *
 */
int async_wait_timeout(aid_t amsgid, ipcarg_t *retval, suseconds_t timeout)
{
    amsg_t *msg = (amsg_t *) amsgid;
   
    /* TODO: Let it go through the event read at least once */
    if (timeout < 0)
        return ETIMEOUT;
   
    futex_down(&async_futex);
    if (msg->done) {
        futex_up(&async_futex);
        goto done;
    }
   
    gettimeofday(&msg->wdata.expires, NULL);
    tv_add(&msg->wdata.expires, timeout);
   
    msg->wdata.fid = fibril_get_id();
    msg->wdata.active = false;
    insert_timeout(&msg->wdata);
   
    /* Leave the async_futex locked when entering this function */
    fibril_switch(FIBRIL_TO_MANAGER);
   
    /* Futex is up automatically after fibril_switch */
   
    if (!msg->done)
        return ETIMEOUT;
   
done:
    if (retval)
        *retval = msg->retval;
   
    free(msg);
   
    return 0;
}
 
/** Wait for specified time.
 *
 * The current fibril is suspended but the thread continues to execute.
 *
 * @param timeout Duration of the wait in microseconds.
 *
 */
void async_usleep(suseconds_t timeout)
{
    amsg_t *msg = malloc(sizeof(*msg));
   
    if (!msg)
        return;
   
    msg->wdata.fid = fibril_get_id();
    msg->wdata.active = false;
   
    gettimeofday(&msg->wdata.expires, NULL);
    tv_add(&msg->wdata.expires, timeout);
   
    futex_down(&async_futex);
   
    insert_timeout(&msg->wdata);
   
    /* Leave the async_futex locked when entering this function */
    fibril_switch(FIBRIL_TO_MANAGER);
   
    /* Futex is up automatically after fibril_switch() */
   
    free(msg);
}
 
/** Setter for client_connection function pointer.
 *
 * @param conn Function that will implement a new connection fibril.
 *
 */
void async_set_client_connection(async_client_conn_t conn)
{
    client_connection = conn;
}
 
/** Setter for interrupt_received function pointer.
 *
 * @param intr Function that will implement a new interrupt
 *             notification fibril.
 */
void async_set_interrupt_received(async_client_conn_t intr)
{
    interrupt_received = intr;
}
 
/** Setter for pending function pointer.
 *
 * @param pend Function that will implement a new pending
 *             operations fibril.
 */
void async_set_pending(async_pending_t pend)
{
    pending = pend;
}
 
/** Pseudo-synchronous message sending - fast version.
 *
 * Send message asynchronously and return only after the reply arrives.
 *
 * This function can only transfer 4 register payload arguments. For
 * transferring more arguments, see the slower async_req_slow().
 *
 * @param phoneid Hash of the phone through which to make the call.
 * @param method  Method of the call.
 * @param arg1    Service-defined payload argument.
 * @param arg2    Service-defined payload argument.
 * @param arg3    Service-defined payload argument.
 * @param arg4    Service-defined payload argument.
 * @param r1      If non-NULL, storage for the 1st reply argument.
 * @param r2      If non-NULL, storage for the 2nd reply argument.
 * @param r3      If non-NULL, storage for the 3rd reply argument.
 * @param r4      If non-NULL, storage for the 4th reply argument.
 * @param r5      If non-NULL, storage for the 5th reply argument.
 *
 * @return Return code of the reply or a negative error code.
 *
 */
ipcarg_t async_req_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t *r1, ipcarg_t *r2,
    ipcarg_t *r3, ipcarg_t *r4, ipcarg_t *r5)
{
    ipc_call_t result;
    aid_t eid = async_send_4(phoneid, method, arg1, arg2, arg3, arg4,
        &result);
   
    ipcarg_t rc;
    async_wait_for(eid, &rc);
   
    if (r1)
        *r1 = IPC_GET_ARG1(result);
   
    if (r2)
        *r2 = IPC_GET_ARG2(result);
   
    if (r3)
        *r3 = IPC_GET_ARG3(result);
   
    if (r4)
        *r4 = IPC_GET_ARG4(result);
   
    if (r5)
        *r5 = IPC_GET_ARG5(result);
   
    return rc;
}
 
/** Pseudo-synchronous message sending - slow version.
 *
 * Send message asynchronously and return only after the reply arrives.
 *
 * @param phoneid Hash of the phone through which to make the call.
 * @param method  Method of the call.
 * @param arg1    Service-defined payload argument.
 * @param arg2    Service-defined payload argument.
 * @param arg3    Service-defined payload argument.
 * @param arg4    Service-defined payload argument.
 * @param arg5    Service-defined payload argument.
 * @param r1      If non-NULL, storage for the 1st reply argument.
 * @param r2      If non-NULL, storage for the 2nd reply argument.
 * @param r3      If non-NULL, storage for the 3rd reply argument.
 * @param r4      If non-NULL, storage for the 4th reply argument.
 * @param r5      If non-NULL, storage for the 5th reply argument.
 *
 * @return Return code of the reply or a negative error code.
 *
 */
ipcarg_t async_req_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, ipcarg_t *r1,
    ipcarg_t *r2, ipcarg_t *r3, ipcarg_t *r4, ipcarg_t *r5)
{
    ipc_call_t result;
    aid_t eid = async_send_5(phoneid, method, arg1, arg2, arg3, arg4, arg5,
        &result);
   
    ipcarg_t rc;
    async_wait_for(eid, &rc);
   
    if (r1)
        *r1 = IPC_GET_ARG1(result);
   
    if (r2)
        *r2 = IPC_GET_ARG2(result);
   
    if (r3)
        *r3 = IPC_GET_ARG3(result);
   
    if (r4)
        *r4 = IPC_GET_ARG4(result);
   
    if (r5)
        *r5 = IPC_GET_ARG5(result);
   
    return rc;
}
 
/** @}
 */
 

Rev 4475	Rev 4509
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	/** @file	32	/** @file
33	*/	33	*/
34		34
35	/**	35	/**
36	* Asynchronous library	36	* Asynchronous library
37	*	37	*
38	* The aim of this library is to provide a facility for writing programs which	38	* The aim of this library is to provide a facility for writing programs which
39	* utilize the asynchronous nature of HelenOS IPC, yet using a normal way of	39	* utilize the asynchronous nature of HelenOS IPC, yet using a normal way of
40	* programming.	40	* programming.
41	*	41	*
42	* You should be able to write very simple multithreaded programs, the async	42	* You should be able to write very simple multithreaded programs, the async
43	* framework will automatically take care of most synchronization problems.	43	* framework will automatically take care of most synchronization problems.
44	*	44	*
45	* Default semantics:	45	* Default semantics:
46	* - async_send_*(): Send asynchronously. If the kernel refuses to send	46	* - async_send_*(): Send asynchronously. If the kernel refuses to send
47	* more messages, [ try to get responses from kernel, if	47	* more messages, [ try to get responses from kernel, if
48	* nothing found, might try synchronous ]	48	* nothing found, might try synchronous ]
49	*	49	*
50	* Example of use (pseudo C):	50	* Example of use (pseudo C):
51	*	51	*
52	* 1) Multithreaded client application	52	* 1) Multithreaded client application
53	*	53	*
54	* fibril_create(fibril1, ...);	54	* fibril_create(fibril1, ...);
55	* fibril_create(fibril2, ...);	55	* fibril_create(fibril2, ...);
56	* ...	56	* ...
57	*	57	*
58	* int fibril1(void *arg)	58	* int fibril1(void *arg)
59	* {	59	* {
60	* conn = ipc_connect_me_to();	60	* conn = ipc_connect_me_to();
61	* c1 = async_send(conn);	61	* c1 = async_send(conn);
62	* c2 = async_send(conn);	62	* c2 = async_send(conn);
63	* async_wait_for(c1);	63	* async_wait_for(c1);
64	* async_wait_for(c2);	64	* async_wait_for(c2);
65	* ...	65	* ...
66	* }	66	* }
67	*	67	*
68	*	68	*
69	* 2) Multithreaded server application	69	* 2) Multithreaded server application
70	*	70	*
71	* main()	71	* main()
72	* {	72	* {
73	* async_manager();	73	* async_manager();
74	* }	74	* }
75	*	75	*
76	* my_client_connection(icallid, *icall)	76	* my_client_connection(icallid, *icall)
77	* {	77	* {
78	* if (want_refuse) {	78	* if (want_refuse) {
79	* ipc_answer_0(icallid, ELIMIT);	79	* ipc_answer_0(icallid, ELIMIT);
80	* return;	80	* return;
81	* }	81	* }
82	* ipc_answer_0(icallid, EOK);	82	* ipc_answer_0(icallid, EOK);
83	*	83	*
84	* callid = async_get_call(&call);	84	* callid = async_get_call(&call);
85	* handle_call(callid, call);	85	* handle_call(callid, call);
86	* ipc_answer_2(callid, 1, 2, 3);	86	* ipc_answer_2(callid, 1, 2, 3);
87	*	87	*
88	* callid = async_get_call(&call);	88	* callid = async_get_call(&call);
89	* ...	89	* ...
90	* }	90	* }
91	*	91	*
92	*/	92	*/
93		93
94	#include <futex.h>	94	#include <futex.h>
95	#include <async.h>	95	#include <async.h>
96	#include <fibril.h>	96	#include <fibril.h>
97	#include <stdio.h>	97	#include <stdio.h>
98	#include <libadt/hash_table.h>	98	#include <adt/hash_table.h>
99	#include <libadt/list.h>	99	#include <adt/list.h>
100	#include <ipc/ipc.h>	100	#include <ipc/ipc.h>
101	#include <assert.h>	101	#include <assert.h>
102	#include <errno.h>	102	#include <errno.h>
103	#include <sys/time.h>	103	#include <sys/time.h>
104	#include <arch/barrier.h>	104	#include <arch/barrier.h>
105	#include <bool.h>	105	#include <bool.h>
106		106
107	atomic_t async_futex = FUTEX_INITIALIZER;	107	atomic_t async_futex = FUTEX_INITIALIZER;
108		108
109	/** Structures of this type represent a waiting fibril. */	109	/** Structures of this type represent a waiting fibril. */
110	typedef struct {	110	typedef struct {
111	/** Expiration time. */	111	/** Expiration time. */
112	struct timeval expires;	112	struct timeval expires;
113		113
114	/** If true, this struct is in the timeout list. */	114	/** If true, this struct is in the timeout list. */
115	bool inlist;	115	bool inlist;
116		116
117	/** Timeout list link. */	117	/** Timeout list link. */
118	link_t link;	118	link_t link;
119		119
120	/** Identification of and link to the waiting fibril. */	120	/** Identification of and link to the waiting fibril. */
121	fid_t fid;	121	fid_t fid;
122		122
123	/** If true, this fibril is currently active. */	123	/** If true, this fibril is currently active. */
124	bool active;	124	bool active;
125		125
126	/** If true, we have timed out. */	126	/** If true, we have timed out. */
127	bool timedout;	127	bool timedout;
128	} awaiter_t;	128	} awaiter_t;
129		129
130	typedef struct {	130	typedef struct {
131	awaiter_t wdata;	131	awaiter_t wdata;
132		132
133	/** If reply was received. */	133	/** If reply was received. */
134	bool done;	134	bool done;
135		135
136	/** Pointer to where the answer data is stored. */	136	/** Pointer to where the answer data is stored. */
137	ipc_call_t *dataptr;	137	ipc_call_t *dataptr;
138		138
139	ipcarg_t retval;	139	ipcarg_t retval;
140	} amsg_t;	140	} amsg_t;
141		141
142	/**	142	/**
143	* Structures of this type are used to group information about a call and a	143	* Structures of this type are used to group information about a call and a
144	* message queue link.	144	* message queue link.
145	*/	145	*/
146	typedef struct {	146	typedef struct {
147	link_t link;	147	link_t link;
148	ipc_callid_t callid;	148	ipc_callid_t callid;
149	ipc_call_t call;	149	ipc_call_t call;
150	} msg_t;	150	} msg_t;
151		151
152	typedef struct {	152	typedef struct {
153	awaiter_t wdata;	153	awaiter_t wdata;
154		154
155	/** Hash table link. */	155	/** Hash table link. */
156	link_t link;	156	link_t link;
157		157
158	/** Incoming phone hash. */	158	/** Incoming phone hash. */
159	ipcarg_t in_phone_hash;	159	ipcarg_t in_phone_hash;
160		160
161	/** Messages that should be delivered to this fibril. */	161	/** Messages that should be delivered to this fibril. */
162	link_t msg_queue;	162	link_t msg_queue;
163		163
164	/** Identification of the opening call. */	164	/** Identification of the opening call. */
165	ipc_callid_t callid;	165	ipc_callid_t callid;
166	/** Call data of the opening call. */	166	/** Call data of the opening call. */
167	ipc_call_t call;	167	ipc_call_t call;
168		168
169	/** Identification of the closing call. */	169	/** Identification of the closing call. */
170	ipc_callid_t close_callid;	170	ipc_callid_t close_callid;
171		171
172	/** Fibril function that will be used to handle the connection. */	172	/** Fibril function that will be used to handle the connection. */
173	void (cfibril)(ipc_callid_t, ipc_call_t );	173	void (cfibril)(ipc_callid_t, ipc_call_t );
174	} connection_t;	174	} connection_t;
175		175
176	/** Identifier of the incoming connection handled by the current fibril. */	176	/** Identifier of the incoming connection handled by the current fibril. */
177	__thread connection_t *FIBRIL_connection;	177	__thread connection_t *FIBRIL_connection;
178		178
179	static void default_client_connection(ipc_callid_t callid, ipc_call_t *call);	179	static void default_client_connection(ipc_callid_t callid, ipc_call_t *call);
180	static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call);	180	static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call);
181	static void default_pending(void);	181	static void default_pending(void);
182		182
183	/**	183	/**
184	* Pointer to a fibril function that will be used to handle connections.	184	* Pointer to a fibril function that will be used to handle connections.
185	*/	185	*/
186	static async_client_conn_t client_connection = default_client_connection;	186	static async_client_conn_t client_connection = default_client_connection;
187		187
188	/**	188	/**
189	* Pointer to a fibril function that will be used to handle interrupt	189	* Pointer to a fibril function that will be used to handle interrupt
190	* notifications.	190	* notifications.
191	*/	191	*/
192	static async_client_conn_t interrupt_received = default_interrupt_received;	192	static async_client_conn_t interrupt_received = default_interrupt_received;
193		193
194	/**	194	/**
195	* Pointer to a fibril function that will be used to handle pending	195	* Pointer to a fibril function that will be used to handle pending
196	* operations.	196	* operations.
197	*/	197	*/
198	static async_pending_t pending = default_pending;	198	static async_pending_t pending = default_pending;
199		199
200	static hash_table_t conn_hash_table;	200	static hash_table_t conn_hash_table;
201	static LIST_INITIALIZE(timeout_list);	201	static LIST_INITIALIZE(timeout_list);
202		202
203	#define CONN_HASH_TABLE_CHAINS 32	203	#define CONN_HASH_TABLE_CHAINS 32
204		204
205	/** Compute hash into the connection hash table based on the source phone hash.	205	/** Compute hash into the connection hash table based on the source phone hash.
206	*	206	*
207	* @param key Pointer to source phone hash.	207	* @param key Pointer to source phone hash.
208	*	208	*
209	* @return Index into the connection hash table.	209	* @return Index into the connection hash table.
210	*	210	*
211	*/	211	*/
212	static hash_index_t conn_hash(unsigned long *key)	212	static hash_index_t conn_hash(unsigned long *key)
213	{	213	{
214	assert(key);	214	assert(key);
215	return (((*key) >> 4) % CONN_HASH_TABLE_CHAINS);	215	return (((*key) >> 4) % CONN_HASH_TABLE_CHAINS);
216	}	216	}
217		217
218	/** Compare hash table item with a key.	218	/** Compare hash table item with a key.
219	*	219	*
220	* @param key Array containing the source phone hash as the only item.	220	* @param key Array containing the source phone hash as the only item.
221	* @param keys Expected 1 but ignored.	221	* @param keys Expected 1 but ignored.
222	* @param item Connection hash table item.	222	* @param item Connection hash table item.
223	*	223	*
224	* @return True on match, false otherwise.	224	* @return True on match, false otherwise.
225	*	225	*
226	*/	226	*/
227	static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)	227	static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)
228	{	228	{
229	connection_t *hs = hash_table_get_instance(item, connection_t, link);	229	connection_t *hs = hash_table_get_instance(item, connection_t, link);
230	return (key[0] == hs->in_phone_hash);	230	return (key[0] == hs->in_phone_hash);
231	}	231	}
232		232
233	/** Connection hash table removal callback function.	233	/** Connection hash table removal callback function.
234	*	234	*
235	* This function is called whenever a connection is removed from the connection	235	* This function is called whenever a connection is removed from the connection
236	* hash table.	236	* hash table.
237	*	237	*
238	* @param item Connection hash table item being removed.	238	* @param item Connection hash table item being removed.
239	*	239	*
240	*/	240	*/
241	static void conn_remove(link_t *item)	241	static void conn_remove(link_t *item)
242	{	242	{
243	free(hash_table_get_instance(item, connection_t, link));	243	free(hash_table_get_instance(item, connection_t, link));
244	}	244	}
245		245
246		246
247	/** Operations for the connection hash table. */	247	/** Operations for the connection hash table. */
248	static hash_table_operations_t conn_hash_table_ops = {	248	static hash_table_operations_t conn_hash_table_ops = {
249	.hash = conn_hash,	249	.hash = conn_hash,
250	.compare = conn_compare,	250	.compare = conn_compare,
251	.remove_callback = conn_remove	251	.remove_callback = conn_remove
252	};	252	};
253		253
254	/** Sort in current fibril's timeout request.	254	/** Sort in current fibril's timeout request.
255	*	255	*
256	* @param wd Wait data of the current fibril.	256	* @param wd Wait data of the current fibril.
257	*	257	*
258	*/	258	*/
259	static void insert_timeout(awaiter_t *wd)	259	static void insert_timeout(awaiter_t *wd)
260	{	260	{
261	wd->timedout = false;	261	wd->timedout = false;
262	wd->inlist = true;	262	wd->inlist = true;
263		263
264	link_t *tmp = timeout_list.next;	264	link_t *tmp = timeout_list.next;
265	while (tmp != &timeout_list) {	265	while (tmp != &timeout_list) {
266	awaiter_t *cur = list_get_instance(tmp, awaiter_t, link);	266	awaiter_t *cur = list_get_instance(tmp, awaiter_t, link);
267		267
268	if (tv_gteq(&cur->expires, &wd->expires))	268	if (tv_gteq(&cur->expires, &wd->expires))
269	break;	269	break;
270		270
271	tmp = tmp->next;	271	tmp = tmp->next;
272	}	272	}
273		273
274	list_append(&wd->link, tmp);	274	list_append(&wd->link, tmp);
275	}	275	}
276		276
277	/** Try to route a call to an appropriate connection fibril.	277	/** Try to route a call to an appropriate connection fibril.
278	*	278	*
279	* If the proper connection fibril is found, a message with the call is added to	279	* If the proper connection fibril is found, a message with the call is added to
280	* its message queue. If the fibril was not active, it is activated and all	280	* its message queue. If the fibril was not active, it is activated and all
281	* timeouts are unregistered.	281	* timeouts are unregistered.
282	*	282	*
283	* @param callid Hash of the incoming call.	283	* @param callid Hash of the incoming call.
284	* @param call Data of the incoming call.	284	* @param call Data of the incoming call.
285	*	285	*
286	* @return False if the call doesn't match any connection.	286	* @return False if the call doesn't match any connection.
287	* True if the call was passed to the respective connection fibril.	287	* True if the call was passed to the respective connection fibril.
288	*	288	*
289	*/	289	*/
290	static bool route_call(ipc_callid_t callid, ipc_call_t *call)	290	static bool route_call(ipc_callid_t callid, ipc_call_t *call)
291	{	291	{
292	futex_down(&async_futex);	292	futex_down(&async_futex);
293		293
294	unsigned long key = call->in_phone_hash;	294	unsigned long key = call->in_phone_hash;
295	link_t *hlp = hash_table_find(&conn_hash_table, &key);	295	link_t *hlp = hash_table_find(&conn_hash_table, &key);
296		296
297	if (!hlp) {	297	if (!hlp) {
298	futex_up(&async_futex);	298	futex_up(&async_futex);
299	return false;	299	return false;
300	}	300	}
301		301
302	connection_t *conn = hash_table_get_instance(hlp, connection_t, link);	302	connection_t *conn = hash_table_get_instance(hlp, connection_t, link);
303		303
304	msg_t msg = malloc(sizeof(msg));	304	msg_t msg = malloc(sizeof(msg));
305	if (!msg) {	305	if (!msg) {
306	futex_up(&async_futex);	306	futex_up(&async_futex);
307	return false;	307	return false;
308	}	308	}
309		309
310	msg->callid = callid;	310	msg->callid = callid;
311	msg->call = *call;	311	msg->call = *call;
312	list_append(&msg->link, &conn->msg_queue);	312	list_append(&msg->link, &conn->msg_queue);
313		313
314	if (IPC_GET_METHOD(*call) == IPC_M_PHONE_HUNGUP)	314	if (IPC_GET_METHOD(*call) == IPC_M_PHONE_HUNGUP)
315	conn->close_callid = callid;	315	conn->close_callid = callid;
316		316
317	/* If the connection fibril is waiting for an event, activate it */	317	/* If the connection fibril is waiting for an event, activate it */
318	if (!conn->wdata.active) {	318	if (!conn->wdata.active) {
319		319
320	/* If in timeout list, remove it */	320	/* If in timeout list, remove it */
321	if (conn->wdata.inlist) {	321	if (conn->wdata.inlist) {
322	conn->wdata.inlist = false;	322	conn->wdata.inlist = false;
323	list_remove(&conn->wdata.link);	323	list_remove(&conn->wdata.link);
324	}	324	}
325		325
326	conn->wdata.active = true;	326	conn->wdata.active = true;
327	fibril_add_ready(conn->wdata.fid);	327	fibril_add_ready(conn->wdata.fid);
328	}	328	}
329		329
330	futex_up(&async_futex);	330	futex_up(&async_futex);
331	return true;	331	return true;
332	}	332	}
333		333
334	/** Notification fibril.	334	/** Notification fibril.
335	*	335	*
336	* When a notification arrives, a fibril with this implementing function is	336	* When a notification arrives, a fibril with this implementing function is
337	* created. It calls interrupt_received() and does the final cleanup.	337	* created. It calls interrupt_received() and does the final cleanup.
338	*	338	*
339	* @param arg Message structure pointer.	339	* @param arg Message structure pointer.
340	*	340	*
341	* @return Always zero.	341	* @return Always zero.
342	*	342	*
343	*/	343	*/
344	static int notification_fibril(void *arg)	344	static int notification_fibril(void *arg)
345	{	345	{
346	msg_t msg = (msg_t ) arg;	346	msg_t msg = (msg_t ) arg;
347	interrupt_received(msg->callid, &msg->call);	347	interrupt_received(msg->callid, &msg->call);
348		348
349	free(msg);	349	free(msg);
350	return 0;	350	return 0;
351	}	351	}
352		352
353	/** Process interrupt notification.	353	/** Process interrupt notification.
354	*	354	*
355	* A new fibril is created which would process the notification.	355	* A new fibril is created which would process the notification.
356	*	356	*
357	* @param callid Hash of the incoming call.	357	* @param callid Hash of the incoming call.
358	* @param call Data of the incoming call.	358	* @param call Data of the incoming call.
359	*	359	*
360	* @return False if an error occured.	360	* @return False if an error occured.
361	* True if the call was passed to the notification fibril.	361	* True if the call was passed to the notification fibril.
362	*	362	*
363	*/	363	*/
364	static bool process_notification(ipc_callid_t callid, ipc_call_t *call)	364	static bool process_notification(ipc_callid_t callid, ipc_call_t *call)
365	{	365	{
366	futex_down(&async_futex);	366	futex_down(&async_futex);
367		367
368	msg_t msg = malloc(sizeof(msg));	368	msg_t msg = malloc(sizeof(msg));
369	if (!msg) {	369	if (!msg) {
370	futex_up(&async_futex);	370	futex_up(&async_futex);
371	return false;	371	return false;
372	}	372	}
373		373
374	msg->callid = callid;	374	msg->callid = callid;
375	msg->call = *call;	375	msg->call = *call;
376		376
377	fid_t fid = fibril_create(notification_fibril, msg);	377	fid_t fid = fibril_create(notification_fibril, msg);
378	fibril_add_ready(fid);	378	fibril_add_ready(fid);
379		379
380	futex_up(&async_futex);	380	futex_up(&async_futex);
381	return true;	381	return true;
382	}	382	}
383		383
384	/** Pending fibril.	384	/** Pending fibril.
385	*	385	*
386	* After each call the pending operations are executed in a separate	386	* After each call the pending operations are executed in a separate
387	* fibril. The function pending() is c.	387	* fibril. The function pending() is c.
388	*	388	*
389	* @param arg Unused.	389	* @param arg Unused.
390	*	390	*
391	* @return Always zero.	391	* @return Always zero.
392	*	392	*
393	*/	393	*/
394	static int pending_fibril(void *arg)	394	static int pending_fibril(void *arg)
395	{	395	{
396	pending();	396	pending();
397		397
398	return 0;	398	return 0;
399	}	399	}
400		400
401	/** Process pending actions.	401	/** Process pending actions.
402	*	402	*
403	* A new fibril is created which would process the pending operations.	403	* A new fibril is created which would process the pending operations.
404	*	404	*
405	* @return False if an error occured.	405	* @return False if an error occured.
406	* True if the execution was passed to the pending fibril.	406	* True if the execution was passed to the pending fibril.
407	*	407	*
408	*/	408	*/
409	static bool process_pending(void)	409	static bool process_pending(void)
410	{	410	{
411	futex_down(&async_futex);	411	futex_down(&async_futex);
412		412
413	fid_t fid = fibril_create(pending_fibril, NULL);	413	fid_t fid = fibril_create(pending_fibril, NULL);
414	fibril_add_ready(fid);	414	fibril_add_ready(fid);
415		415
416	futex_up(&async_futex);	416	futex_up(&async_futex);
417	return true;	417	return true;
418	}	418	}
419		419
420	/** Return new incoming message for the current (fibril-local) connection.	420	/** Return new incoming message for the current (fibril-local) connection.
421	*	421	*
422	* @param call Storage where the incoming call data will be stored.	422	* @param call Storage where the incoming call data will be stored.
423	* @param usecs Timeout in microseconds. Zero denotes no timeout.	423	* @param usecs Timeout in microseconds. Zero denotes no timeout.
424	*	424	*
425	* @return If no timeout was specified, then a hash of the	425	* @return If no timeout was specified, then a hash of the
426	* incoming call is returned. If a timeout is specified,	426	* incoming call is returned. If a timeout is specified,
427	* then a hash of the incoming call is returned unless	427	* then a hash of the incoming call is returned unless
428	* the timeout expires prior to receiving a message. In	428	* the timeout expires prior to receiving a message. In
429	* that case zero is returned.	429	* that case zero is returned.
430	*	430	*
431	*/	431	*/
432	ipc_callid_t async_get_call_timeout(ipc_call_t *call, suseconds_t usecs)	432	ipc_callid_t async_get_call_timeout(ipc_call_t *call, suseconds_t usecs)
433	{	433	{
434	assert(FIBRIL_connection);	434	assert(FIBRIL_connection);
435		435
436	/* Why doing this?	436	/* Why doing this?
437	* GCC 4.1.0 coughs on FIBRIL_connection-> dereference.	437	* GCC 4.1.0 coughs on FIBRIL_connection-> dereference.
438	* GCC 4.1.1 happilly puts the rdhwr instruction in delay slot.	438	* GCC 4.1.1 happilly puts the rdhwr instruction in delay slot.
439	* I would never expect to find so many errors in	439	* I would never expect to find so many errors in
440	* a compiler.	440	* a compiler.
441	*/	441	*/
442	connection_t *conn = FIBRIL_connection;	442	connection_t *conn = FIBRIL_connection;
443		443
444	futex_down(&async_futex);	444	futex_down(&async_futex);
445		445
446	if (usecs) {	446	if (usecs) {
447	gettimeofday(&conn->wdata.expires, NULL);	447	gettimeofday(&conn->wdata.expires, NULL);
448	tv_add(&conn->wdata.expires, usecs);	448	tv_add(&conn->wdata.expires, usecs);
449	} else	449	} else
450	conn->wdata.inlist = false;	450	conn->wdata.inlist = false;
451		451
452	/* If nothing in queue, wait until something arrives */	452	/* If nothing in queue, wait until something arrives */
453	while (list_empty(&conn->msg_queue)) {	453	while (list_empty(&conn->msg_queue)) {
454	if (usecs)	454	if (usecs)
455	insert_timeout(&conn->wdata);	455	insert_timeout(&conn->wdata);
456		456
457	conn->wdata.active = false;	457	conn->wdata.active = false;
458		458
459	/*	459	/*
460	* Note: the current fibril will be rescheduled either due to a	460	* Note: the current fibril will be rescheduled either due to a
461	* timeout or due to an arriving message destined to it. In the	461	* timeout or due to an arriving message destined to it. In the
462	* former case, handle_expired_timeouts() and, in the latter	462	* former case, handle_expired_timeouts() and, in the latter
463	* case, route_call() will perform the wakeup.	463	* case, route_call() will perform the wakeup.
464	*/	464	*/
465	fibril_switch(FIBRIL_TO_MANAGER);	465	fibril_switch(FIBRIL_TO_MANAGER);
466		466
467	/*	467	/*
468	* Futex is up after getting back from async_manager.	468	* Futex is up after getting back from async_manager.
469	* Get it again.	469	* Get it again.
470	*/	470	*/
471	futex_down(&async_futex);	471	futex_down(&async_futex);
472	if ((usecs) && (conn->wdata.timedout)	472	if ((usecs) && (conn->wdata.timedout)
473	&& (list_empty(&conn->msg_queue))) {	473	&& (list_empty(&conn->msg_queue))) {
474	/* If we timed out -> exit */	474	/* If we timed out -> exit */
475	futex_up(&async_futex);	475	futex_up(&async_futex);
476	return 0;	476	return 0;
477	}	477	}
478	}	478	}
479		479
480	msg_t *msg = list_get_instance(conn->msg_queue.next, msg_t, link);	480	msg_t *msg = list_get_instance(conn->msg_queue.next, msg_t, link);
481	list_remove(&msg->link);	481	list_remove(&msg->link);
482		482
483	ipc_callid_t callid = msg->callid;	483	ipc_callid_t callid = msg->callid;
484	*call = msg->call;	484	*call = msg->call;
485	free(msg);	485	free(msg);
486		486
487	futex_up(&async_futex);	487	futex_up(&async_futex);
488	return callid;	488	return callid;
489	}	489	}
490		490
491	/** Default fibril function that gets called to handle new connection.	491	/** Default fibril function that gets called to handle new connection.
492	*	492	*
493	* This function is defined as a weak symbol - to be redefined in user code.	493	* This function is defined as a weak symbol - to be redefined in user code.
494	*	494	*
495	* @param callid Hash of the incoming call.	495	* @param callid Hash of the incoming call.
496	* @param call Data of the incoming call.	496	* @param call Data of the incoming call.
497	*	497	*
498	*/	498	*/
499	static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)	499	static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)
500	{	500	{

Subversion Repositories HelenOS

(root)/trunk/uspace/lib/libc/generic/async.c – Rev 4475 → 4509