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

Subversion Repositories HelenOS

(root)/trunk/uspace/lib/libc/generic/async.c – Rev 2619 → 2621