WebSVN – HelenOS-historic – Diff – /uspace/trunk/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.
 */
 
/**
 * 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:
 * - 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:
 *
 * 1) Multithreaded client application
 *  create_thread(thread1);
 *  create_thread(thread2);
 *  ...
 *  
 *  thread1() {
 *        conn = ipc_connect_me_to();
 *        c1 = send(conn);
 *        c2 = send(conn);
 *        wait_for(c1);
 *        wait_for(c2);
 *  }
 *
 *
 * 2) Multithreaded server application
 * main() {
 *      async_manager();
 * }
 *
 *
 * client_connection(icallid, *icall) {
 *       if (want_refuse) {
 *           ipc_answer_fast(icallid, ELIMIT, 0, 0);
 *           return;
 *       }
 *       ipc_answer_fast(icallid, 0, 0, 0);
 *
 *       callid = async_get_call(&call);
 *       handle(callid, call);
 *       ipc_answer_fast(callid, 1,2,3);
 *
 *       callid = async_get_call(&call);
 *       ....
 * }
 *
 * TODO: Detaching/joining dead psthreads?
 */
#include <futex.h>
#include <async.h>
#include <psthread.h>
#include <stdio.h>
#include <libadt/hash_table.h>
#include <libadt/list.h>
#include <ipc/ipc.h>
#include <assert.h>
#include <errno.h>
 
static atomic_t async_futex = FUTEX_INITIALIZER;
static hash_table_t conn_hash_table;
 
typedef struct {
    pstid_t ptid;                /**< Thread waiting for this message */
    int active;                  /**< If this thread is currently active */
    int done;                    /**< If reply was received */
    ipc_call_t *dataptr;         /**< Pointer where the answer data
                      *   should be stored */
    ipcarg_t retval;
} amsg_t;
 
typedef struct {
    link_t link;
    ipc_callid_t callid;
    ipc_call_t call;
} msg_t;
 
typedef struct {
    link_t link;
    ipcarg_t in_phone_hash;     /**< Incoming phone hash. */
    link_t msg_queue;              /**< Messages that should be delivered to this thread */
    pstid_t ptid;                /**< Thread associated with this connection */
    int active;                     /**< If this thread is currently active */
    /* Structures for connection opening packet */
    ipc_callid_t callid;
    ipc_call_t call;
    void (*cthread)(ipc_callid_t,ipc_call_t *);
} connection_t;
 
__thread connection_t *PS_connection;
 
/* Hash table functions */
#define CONN_HASH_TABLE_CHAINS  32
 
static hash_index_t conn_hash(unsigned long *key)
{
    assert(key);
    return ((*key) >> 4) % CONN_HASH_TABLE_CHAINS;
}
 
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;
}
 
static void conn_remove(link_t *item)
{
    free(hash_table_get_instance(item, connection_t, link));
}
 
 
/** Operations for NS hash table. */
static hash_table_operations_t conn_hash_table_ops = {
    .hash = conn_hash,
    .compare = conn_compare,
    .remove_callback = conn_remove
};
 
/*************************************************/
 
/** Try to route a call to an appropriate connection thread
 *
 */
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 (!conn->active) {
        conn->active = 1;
        psthread_add_ready(conn->ptid);
    }
 
    futex_up(&async_futex);
 
    return 1;
}
 
/** Return new incoming message for current(thread-local) connection */
ipc_callid_t async_get_call(ipc_call_t *call)
{
    msg_t *msg;
    ipc_callid_t callid;
    connection_t *conn;
   
    futex_down(&async_futex);
 
    conn = PS_connection;
    /* If nothing in queue, wait until something appears */
    if (list_empty(&conn->msg_queue)) {
        conn->active = 0;
        psthread_schedule_next_adv(PS_TO_MANAGER);
    }
   
    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;
}
 
/** Thread function that gets created on new connection
 *
 * This function is defined as a weak symbol - to be redefined in
 * user code.
 */
void client_connection(ipc_callid_t callid, ipc_call_t *call)
{
    ipc_answer_fast(callid, ENOENT, 0, 0);
}
 
/** Wrapper for client connection thread
 *
 * When new connection arrives, thread with this function is created.
 * It calls client_connection and does final cleanup.
 *
 * @parameter arg Connection structure pointer
 */
static int connection_thread(void  *arg)
{
    unsigned long key;
    msg_t *msg;
    connection_t *conn;
 
    /* Setup thread local connection pointer */
    PS_connection = (connection_t *)arg;
    conn = PS_connection;
    conn->cthread(conn->callid, &conn->call);
 
    /* Remove myself from connection hash table */
    futex_down(&async_futex);
    key = conn->in_phone_hash;
    hash_table_remove(&conn_hash_table, &key, 1);
    futex_up(&async_futex);
    /* Answer all remaining messages with ehangup */
    while (!list_empty(&conn->msg_queue)) {
        msg = list_get_instance(conn->msg_queue.next, msg_t, link);
        list_remove(&msg->link);
        ipc_answer_fast(msg->callid, EHANGUP, 0, 0);
        free(msg);
    }
}
 
/** Create new thread for a new connection
 *
 * Creates new thread 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
 * threads.
 *
 * @param callid Callid of the IPC_M_CONNECT_ME_TO packet
 * @param call Call data of the opening packet
 * @param cthread Thread function that should be called upon
 *                opening the connection
 * @return New thread id
 */
pstid_t async_new_connection(ipc_callid_t callid, ipc_call_t *call,
                 void (*cthread)(ipc_callid_t,ipc_call_t *))
{
    pstid_t ptid;
    connection_t *conn;
    unsigned long key;
 
    conn = malloc(sizeof(*conn));
    if (!conn) {
        ipc_answer_fast(callid, ENOMEM, 0, 0);
        return NULL;
    }
    conn->in_phone_hash = IPC_GET_ARG3(*call);
    list_initialize(&conn->msg_queue);
    conn->ptid = psthread_create(connection_thread, conn);
    conn->callid = callid;
    conn->call = *call;
    conn->active = 1; /* We will activate it asap */
    conn->cthread = cthread;
    list_initialize(&conn->link);
    if (!conn->ptid) {
        free(conn);
        ipc_answer_fast(callid, ENOMEM, 0, 0);
        return NULL;
    }
    key = conn->in_phone_hash;
    futex_down(&async_futex);
    /* Add connection to hash table */
    hash_table_insert(&conn_hash_table, &key, &conn->link);
    futex_up(&async_futex);
 
    psthread_add_ready(conn->ptid);
 
    return conn->ptid;
}
 
/** Handle call that was received */
static void handle_call(ipc_callid_t callid, ipc_call_t *call)
{
    if (route_call(callid, call))
        return;
 
    switch (IPC_GET_METHOD(*call)) {
    case IPC_M_INTERRUPT:
        break;
    case IPC_M_CONNECT_ME_TO:
        /* Open new connection with thread etc. */
        async_new_connection(callid, call, client_connection);
        break;
    default:
        ipc_answer_fast(callid, EHANGUP, 0, 0);
    }
}
 
/** Endless loop dispatching incoming calls and answers */
int async_manager()
{
    ipc_call_t call;
    ipc_callid_t callid;
    int timeout;
 
    while (1) {
        if (psthread_schedule_next_adv(PS_FROM_MANAGER)) {
            futex_up(&async_futex); /* async_futex is always held
                        * when entering manager thread
                        */
            continue;
        }
/*
        if (expires)
            timeout = .... ;
        else
*/
            timeout = SYNCH_NO_TIMEOUT;
        callid = ipc_wait_cycle(&call, timeout, SYNCH_BLOCKING);
 
        if (!callid) {
//          handle_expired_timeouts.......;
            continue;
        }
 
        if (callid & IPC_CALLID_ANSWERED)
            continue;
 
        handle_call(callid, &call);
    }
}
 
/** Function to start async_manager as a standalone thread
 *
 * When more kernel threads are used, one async manager should
 * exist per thread. The particular implementation may change,
 * currently one async_manager is started automatically per kernel
 * thread except main thread.
 */
static int async_manager_thread(void *arg)
{
    futex_up(&async_futex); /* async_futex is always locked when entering
                * manager */
    async_manager();
}
 
/** Add one manager to manager list */
void async_create_manager(void)
{
    pstid_t ptid;
 
    ptid = psthread_create(async_manager_thread, NULL);
    psthread_add_manager(ptid);
}
 
/** Remove one manager from manager list */
void async_destroy_manager(void)
{
    psthread_remove_manager();
}
 
/** Initialize internal structures needed for async manager */
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;
    }
   
}
 
/** IPC handler for messages in async framework
 *
 * Notify thread that is waiting for this message, that it arrived
 */
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;
 
    /* TODO: memory barrier?? */
    msg->done = 1;
    if (! msg->active) {
        msg->active = 1;
        psthread_add_ready(msg->ptid);
    }
    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.
 */
aid_t async_send_2(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,
           ipc_call_t *dataptr)
{
    amsg_t *msg;
 
    msg = malloc(sizeof(*msg));
    msg->active = 1;
    msg->done = 0;
    msg->dataptr = dataptr;
    ipc_call_async_2(phoneid,method,arg1,arg2,msg,reply_received);
 
    return (aid_t) msg;
}
 
/** Wait for a message sent by async framework
 *
 * @param amsgid Message ID to wait for
 * @param retval Pointer to variable where will be stored retval
 *               of the answered message. If NULL, it is ignored.
 *
 */
void async_wait_for(aid_t amsgid, ipcarg_t *retval)
{
    amsg_t *msg = (amsg_t *) amsgid;
    connection_t *conn;
 
    futex_down(&async_futex);
    if (msg->done) {
        futex_up(&async_futex);
        goto done;
    }
 
    msg->ptid = psthread_get_id();
    msg->active = 0;
    /* Leave locked async_futex when entering this function */
    psthread_schedule_next_adv(PS_TO_MANAGER);
    /* futex is up automatically after psthread_schedule_next...*/
done:
    if (retval)
        *retval = msg->retval;
    free(msg);
}
 
 
/* int async_wait_timeout(aid_t amsgid, ipcarg_t *retval, int timeout) */
/* { */
/*  amsg_t *msg = (amsg_t *) amsgid; */
/*  connection_t *conn; */
 
/*  futex_down(&async_futex); */
/*  if (msg->done) { */
/*      futex_up(&async_futex); */
/*      goto done; */
/*  } */
 
/*  msg->ptid = psthread_get_id(); */
/*  msg->active = 0; */
/*  msg->expires = gettime() + timeout; */
/*  setup_timeouts_etc...(); */
 
/*  /\* Leave locked async_futex when entering this function *\/ */
/*  psthread_schedule_next_adv(PS_TO_MANAGER); */
/*  /\* futex is up automatically after psthread_schedule_next...*\/ */
 
/*  if (!msg->done) */
/*      return casy-casy; */
 
/*  /\* TODO: When memory barrier in reply_received, we can skip this *\/ */
/*  futex_down(&async_futex); */
/*  futex_up(&async_futex); */
/* done: */
   
/*  if (retval) */
/*      *retval = msg->retval; */
/*  free(msg); */
/* } */
 
 

Rev 1427	Rev 1435
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	/**	29	/**
30	* Asynchronous library	30	* Asynchronous library
31	*	31	*
32	* The aim of this library is facilitating writing programs utilizing	32	* The aim of this library is facilitating writing programs utilizing
33	* the asynchronous nature of Helenos IPC, yet using a normal way	33	* the asynchronous nature of Helenos IPC, yet using a normal way
34	* of programming.	34	* of programming.
35	*	35	*
36	* You should be able to write very simple multithreaded programs,	36	* You should be able to write very simple multithreaded programs,
37	* the async framework will automatically take care of most synchronization	37	* the async framework will automatically take care of most synchronization
38	* problems.	38	* problems.
39	*	39	*
40	* Default semantics:	40	* Default semantics:
41	* - send() - send asynchronously. If the kernel refuses to send more	41	* - send() - send asynchronously. If the kernel refuses to send more
42	* messages, [ try to get responses from kernel, if nothing	42	* messages, [ try to get responses from kernel, if nothing
43	* found, might try synchronous ]	43	* found, might try synchronous ]
44	*	44	*
45	* Example of use:	45	* Example of use:
46	*	46	*
47	* 1) Multithreaded client application	47	* 1) Multithreaded client application
48	* create_thread(thread1);	48	* create_thread(thread1);
49	* create_thread(thread2);	49	* create_thread(thread2);
50	* ...	50	* ...
51	*	51	*
52	* thread1() {	52	* thread1() {
53	* conn = ipc_connect_me_to();	53	* conn = ipc_connect_me_to();
54	* c1 = send(conn);	54	* c1 = send(conn);
55	* c2 = send(conn);	55	* c2 = send(conn);
56	* wait_for(c1);	56	* wait_for(c1);
57	* wait_for(c2);	57	* wait_for(c2);
58	* }	58	* }
59	*	59	*
60	*	60	*
61	* 2) Multithreaded server application	61	* 2) Multithreaded server application
62	* main() {	62	* main() {
63	* async_manager();	63	* async_manager();
64	* }	64	* }
65	*	65	*
66	*	66	*
67	* client_connection(icallid, *icall) {	67	* client_connection(icallid, *icall) {
68	* if (want_refuse) {	68	* if (want_refuse) {
69	* ipc_answer_fast(icallid, ELIMIT, 0, 0);	69	* ipc_answer_fast(icallid, ELIMIT, 0, 0);
70	* return;	70	* return;
71	* }	71	* }
72	* ipc_answer_fast(icallid, 0, 0, 0);	72	* ipc_answer_fast(icallid, 0, 0, 0);
73	*	73	*
74	* callid = async_get_call(&call);	74	* callid = async_get_call(&call);
75	* handle(callid, call);	75	* handle(callid, call);
76	* ipc_answer_fast(callid, 1,2,3);	76	* ipc_answer_fast(callid, 1,2,3);
77	*	77	*
78	* callid = async_get_call(&call);	78	* callid = async_get_call(&call);
79	* ....	79	* ....
80	* }	80	* }
81	*	81	*
82	* TODO: Detaching/joining dead psthreads?	82	* TODO: Detaching/joining dead psthreads?
83	*/	83	*/
84	#include <futex.h>	84	#include <futex.h>
85	#include <async.h>	85	#include <async.h>
86	#include <psthread.h>	86	#include <psthread.h>
87	#include <stdio.h>	87	#include <stdio.h>
88	#include <libadt/hash_table.h>	88	#include <libadt/hash_table.h>
89	#include <libadt/list.h>	89	#include <libadt/list.h>
90	#include <ipc/ipc.h>	90	#include <ipc/ipc.h>
91	#include <assert.h>	91	#include <assert.h>
92	#include <errno.h>	92	#include <errno.h>
93		93
94	static atomic_t async_futex = FUTEX_INITIALIZER;	94	static atomic_t async_futex = FUTEX_INITIALIZER;
95	static hash_table_t conn_hash_table;	95	static hash_table_t conn_hash_table;
96		96
97	typedef struct {	97	typedef struct {
98	pstid_t ptid; /*< Thread waiting for this message /	98	pstid_t ptid; /*< Thread waiting for this message /
99	int active; /*< If this thread is currently active /	99	int active; /*< If this thread is currently active /
100	int done; /*< If reply was received /	100	int done; /*< If reply was received /
101	ipc_call_t dataptr; /*< Pointer where the answer data	101	ipc_call_t dataptr; /*< Pointer where the answer data
102	* should be stored */	102	* should be stored */
103	ipcarg_t retval;	103	ipcarg_t retval;
104	} amsg_t;	104	} amsg_t;
105		105
106	typedef struct {	106	typedef struct {
107	link_t link;	107	link_t link;
108	ipc_callid_t callid;	108	ipc_callid_t callid;
109	ipc_call_t call;	109	ipc_call_t call;
110	} msg_t;	110	} msg_t;
111		111
112	typedef struct {	112	typedef struct {
113	link_t link;	113	link_t link;
114	ipcarg_t in_phone_hash; /*< Incoming phone hash. /	114	ipcarg_t in_phone_hash; /*< Incoming phone hash. /
115	link_t msg_queue; /*< Messages that should be delivered to this thread /	115	link_t msg_queue; /*< Messages that should be delivered to this thread /
116	pstid_t ptid; /*< Thread associated with this connection /	116	pstid_t ptid; /*< Thread associated with this connection /
117	int active; /*< If this thread is currently active /	117	int active; /*< If this thread is currently active /
118	/* Structures for connection opening packet */	118	/* Structures for connection opening packet */
119	ipc_callid_t callid;	119	ipc_callid_t callid;
120	ipc_call_t call;	120	ipc_call_t call;
121	void (cthread)(ipc_callid_t,ipc_call_t );	121	void (cthread)(ipc_callid_t,ipc_call_t );
122	} connection_t;	122	} connection_t;
123		123
124	__thread connection_t *PS_connection;	124	__thread connection_t *PS_connection;
125		125
126	/* Hash table functions */	126	/* Hash table functions */
127	#define CONN_HASH_TABLE_CHAINS 32	127	#define CONN_HASH_TABLE_CHAINS 32
128		128
129	static hash_index_t conn_hash(unsigned long *key)	129	static hash_index_t conn_hash(unsigned long *key)
130	{	130	{
131	assert(key);	131	assert(key);
132	return ((*key) >> 4) % CONN_HASH_TABLE_CHAINS;	132	return ((*key) >> 4) % CONN_HASH_TABLE_CHAINS;
133	}	133	}
134		134
135	static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)	135	static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)
136	{	136	{
137	connection_t *hs;	137	connection_t *hs;
138		138
139	hs = hash_table_get_instance(item, connection_t, link);	139	hs = hash_table_get_instance(item, connection_t, link);
140		140
141	return key[0] == hs->in_phone_hash;	141	return key[0] == hs->in_phone_hash;
142	}	142	}
143		143
144	static void conn_remove(link_t *item)	144	static void conn_remove(link_t *item)
145	{	145	{
146	free(hash_table_get_instance(item, connection_t, link));	146	free(hash_table_get_instance(item, connection_t, link));
147	}	147	}
148		148
149		149
150	/** Operations for NS hash table. */	150	/** Operations for NS hash table. */
151	static hash_table_operations_t conn_hash_table_ops = {	151	static hash_table_operations_t conn_hash_table_ops = {
152	.hash = conn_hash,	152	.hash = conn_hash,
153	.compare = conn_compare,	153	.compare = conn_compare,
154	.remove_callback = conn_remove	154	.remove_callback = conn_remove
155	};	155	};
156		156
157	/*************************************************/	157	/*************************************************/
158		158
159	/** Try to route a call to an appropriate connection thread	159	/** Try to route a call to an appropriate connection thread
160	*	160	*
161	*/	161	*/
162	static int route_call(ipc_callid_t callid, ipc_call_t *call)	162	static int route_call(ipc_callid_t callid, ipc_call_t *call)
163	{	163	{
164	connection_t *conn;	164	connection_t *conn;
165	msg_t *msg;	165	msg_t *msg;
166	link_t *hlp;	166	link_t *hlp;
167	unsigned long key;	167	unsigned long key;
168		168
169	futex_down(&async_futex);	169	futex_down(&async_futex);
170		170
171	key = call->in_phone_hash;	171	key = call->in_phone_hash;
172	hlp = hash_table_find(&conn_hash_table, &key);	172	hlp = hash_table_find(&conn_hash_table, &key);
173	if (!hlp) {	173	if (!hlp) {
174	futex_up(&async_futex);	174	futex_up(&async_futex);
175	return 0;	175	return 0;
176	}	176	}
177	conn = hash_table_get_instance(hlp, connection_t, link);	177	conn = hash_table_get_instance(hlp, connection_t, link);
178		178
179	msg = malloc(sizeof(*msg));	179	msg = malloc(sizeof(*msg));
180	msg->callid = callid;	180	msg->callid = callid;
181	msg->call = *call;	181	msg->call = *call;
182	list_append(&msg->link, &conn->msg_queue);	182	list_append(&msg->link, &conn->msg_queue);
183		183
184	if (!conn->active) {	184	if (!conn->active) {
185	conn->active = 1;	185	conn->active = 1;
186	psthread_add_ready(conn->ptid);	186	psthread_add_ready(conn->ptid);
187	}	187	}
188		188
189	futex_up(&async_futex);	189	futex_up(&async_futex);
190		190
191	return 1;	191	return 1;
192	}	192	}
193		193
194	/** Return new incoming message for current(thread-local) connection */	194	/** Return new incoming message for current(thread-local) connection */
195	ipc_callid_t async_get_call(ipc_call_t *call)	195	ipc_callid_t async_get_call(ipc_call_t *call)
196	{	196	{
197	msg_t *msg;	197	msg_t *msg;
198	ipc_callid_t callid;	198	ipc_callid_t callid;
199	connection_t *conn;	199	connection_t *conn;
200		200
201	futex_down(&async_futex);	201	futex_down(&async_futex);
202		202
203	conn = PS_connection;	203	conn = PS_connection;
204	/* If nothing in queue, wait until something appears */	204	/* If nothing in queue, wait until something appears */
205	if (list_empty(&conn->msg_queue)) {	205	if (list_empty(&conn->msg_queue)) {
206	conn->active = 0;	206	conn->active = 0;
207	psthread_schedule_next_adv(PS_TO_MANAGER);	207	psthread_schedule_next_adv(PS_TO_MANAGER);
208	}	208	}
209		209
210	msg = list_get_instance(conn->msg_queue.next, msg_t, link);	210	msg = list_get_instance(conn->msg_queue.next, msg_t, link);
211	list_remove(&msg->link);	211	list_remove(&msg->link);
212	callid = msg->callid;	212	callid = msg->callid;
213	*call = msg->call;	213	*call = msg->call;
214	free(msg);	214	free(msg);
215		215
216	futex_up(&async_futex);	216	futex_up(&async_futex);
217	return callid;	217	return callid;
218	}	218	}
219		219
220	/** Thread function that gets created on new connection	220	/** Thread function that gets created on new connection
221	*	221	*
222	* This function is defined as a weak symbol - to be redefined in	222	* This function is defined as a weak symbol - to be redefined in
223	* user code.	223	* user code.
224	*/	224	*/
225	void client_connection(ipc_callid_t callid, ipc_call_t *call)	225	void client_connection(ipc_callid_t callid, ipc_call_t *call)
226	{	226	{
227	ipc_answer_fast(callid, ENOENT, 0, 0);	227	ipc_answer_fast(callid, ENOENT, 0, 0);
228	}	228	}
229		229
230	/** Wrapper for client connection thread	230	/** Wrapper for client connection thread
231	*	231	*
232	* When new connection arrives, thread with this function is created.	232	* When new connection arrives, thread with this function is created.
233	* It calls client_connection and does final cleanup.	233	* It calls client_connection and does final cleanup.
234	*	234	*
235	* @parameter arg Connection structure pointer	235	* @parameter arg Connection structure pointer
236	*/	236	*/
237	static int connection_thread(void *arg)	237	static int connection_thread(void *arg)
238	{	238	{
239	unsigned long key;	239	unsigned long key;
240	msg_t *msg;	240	msg_t *msg;
241	connection_t *conn;	241	connection_t *conn;
242		242
243	/* Setup thread local connection pointer */	243	/* Setup thread local connection pointer */
244	PS_connection = (connection_t *)arg;	244	PS_connection = (connection_t *)arg;
245	conn = PS_connection;	245	conn = PS_connection;
246	conn->cthread(conn->callid, &conn->call);	246	conn->cthread(conn->callid, &conn->call);
247		247
248	/* Remove myself from connection hash table */	248	/* Remove myself from connection hash table */
249	futex_down(&async_futex);	249	futex_down(&async_futex);
250	key = conn->in_phone_hash;	250	key = conn->in_phone_hash;
251	hash_table_remove(&conn_hash_table, &key, 1);	251	hash_table_remove(&conn_hash_table, &key, 1);
252	futex_up(&async_futex);	252	futex_up(&async_futex);
253	/* Answer all remaining messages with ehangup */	253	/* Answer all remaining messages with ehangup */
254	while (!list_empty(&conn->msg_queue)) {	254	while (!list_empty(&conn->msg_queue)) {
255	msg = list_get_instance(conn->msg_queue.next, msg_t, link);	255	msg = list_get_instance(conn->msg_queue.next, msg_t, link);
256	list_remove(&msg->link);	256	list_remove(&msg->link);
257	ipc_answer_fast(msg->callid, EHANGUP, 0, 0);	257	ipc_answer_fast(msg->callid, EHANGUP, 0, 0);
258	free(msg);	258	free(msg);
259	}	259	}
260	}	260	}
261		261
262	/** Create new thread for a new connection	262	/** Create new thread for a new connection
263	*	263	*
264	* Creates new thread for connection, fills in connection	264	* Creates new thread for connection, fills in connection
265	* structures and inserts it into the hash table, so that	265	* structures and inserts it into the hash table, so that
266	* later we can easily do routing of messages to particular	266	* later we can easily do routing of messages to particular
267	* threads.	267	* threads.
268	*	268	*
269	* @param callid Callid of the IPC_M_CONNECT_ME_TO packet	269	* @param callid Callid of the IPC_M_CONNECT_ME_TO packet
270	* @param call Call data of the opening packet	270	* @param call Call data of the opening packet
271	* @param cthread Thread function that should be called upon	271	* @param cthread Thread function that should be called upon
272	* opening the connection	272	* opening the connection
273	* @return New thread id	273	* @return New thread id
274	*/	274	*/
275	pstid_t async_new_connection(ipc_callid_t callid, ipc_call_t *call,	275	pstid_t async_new_connection(ipc_callid_t callid, ipc_call_t *call,
276	void (cthread)(ipc_callid_t,ipc_call_t ))	276	void (cthread)(ipc_callid_t,ipc_call_t ))
277	{	277	{
278	pstid_t ptid;	278	pstid_t ptid;
279	connection_t *conn;	279	connection_t *conn;
280	unsigned long key;	280	unsigned long key;
281		281
282	conn = malloc(sizeof(*conn));	282	conn = malloc(sizeof(*conn));
283	if (!conn) {	283	if (!conn) {
284	ipc_answer_fast(callid, ENOMEM, 0, 0);	284	ipc_answer_fast(callid, ENOMEM, 0, 0);
285	return NULL;	285	return NULL;
286	}	286	}
287	conn->in_phone_hash = IPC_GET_ARG3(*call);	287	conn->in_phone_hash = IPC_GET_ARG3(*call);
288	list_initialize(&conn->msg_queue);	288	list_initialize(&conn->msg_queue);
289	conn->ptid = psthread_create(connection_thread, conn);	289	conn->ptid = psthread_create(connection_thread, conn);
290	conn->callid = callid;	290	conn->callid = callid;
291	conn->call = *call;	291	conn->call = *call;
292	conn->active = 1; /* We will activate it asap */	292	conn->active = 1; /* We will activate it asap */
293	conn->cthread = cthread;	293	conn->cthread = cthread;
294	list_initialize(&conn->link);	294	list_initialize(&conn->link);
295	if (!conn->ptid) {	295	if (!conn->ptid) {
296	free(conn);	296	free(conn);
297	ipc_answer_fast(callid, ENOMEM, 0, 0);	297	ipc_answer_fast(callid, ENOMEM, 0, 0);
298	return NULL;	298	return NULL;
299	}	299	}
300	key = conn->in_phone_hash;	300	key = conn->in_phone_hash;
301	futex_down(&async_futex);	301	futex_down(&async_futex);
302	/* Add connection to hash table */	302	/* Add connection to hash table */
303	hash_table_insert(&conn_hash_table, &key, &conn->link);	303	hash_table_insert(&conn_hash_table, &key, &conn->link);
304	futex_up(&async_futex);	304	futex_up(&async_futex);
305		305
306	psthread_add_ready(conn->ptid);	306	psthread_add_ready(conn->ptid);
307		307
308	return conn->ptid;	308	return conn->ptid;
309	}	309	}
310		310
311	/** Handle call that was received */	311	/** Handle call that was received */
312	static void handle_call(ipc_callid_t callid, ipc_call_t *call)	312	static void handle_call(ipc_callid_t callid, ipc_call_t *call)
313	{	313	{
314	if (route_call(callid, call))	314	if (route_call(callid, call))
315	return;	315	return;
316		316
317	switch (IPC_GET_METHOD(*call)) {	317	switch (IPC_GET_METHOD(*call)) {
318	case IPC_M_INTERRUPT:	318	case IPC_M_INTERRUPT:
319	break;	319	break;
320	case IPC_M_CONNECT_ME_TO:	320	case IPC_M_CONNECT_ME_TO:
321	/* Open new connection with thread etc. */	321	/* Open new connection with thread etc. */
322	async_new_connection(callid, call, client_connection);	322	async_new_connection(callid, call, client_connection);
323	break;	323	break;
324	default:	324	default:
325	ipc_answer_fast(callid, EHANGUP, 0, 0);	325	ipc_answer_fast(callid, EHANGUP, 0, 0);
326	}	326	}
327	}	327	}
328		328
329	/** Endless loop dispatching incoming calls and answers */	329	/** Endless loop dispatching incoming calls and answers */
330	int async_manager()	330	int async_manager()
331	{	331	{
332	ipc_call_t call;	332	ipc_call_t call;
333	ipc_callid_t callid;	333	ipc_callid_t callid;
-		334	int timeout;
334		335
335	while (1) {	336	while (1) {
336	if (psthread_schedule_next_adv(PS_FROM_MANAGER)) {	337	if (psthread_schedule_next_adv(PS_FROM_MANAGER)) {
337	futex_up(&async_futex); /* async_futex is always held	338	futex_up(&async_futex); /* async_futex is always held
338	* when entering manager thread	339	* when entering manager thread
339	*/	340	*/
340	continue;	341	continue;
341	}	342	}
-		343	/*
-		344	if (expires)
-		345	timeout = .... ;
-		346	else
-		347	*/
-		348	timeout = SYNCH_NO_TIMEOUT;
342	callid = ipc_wait_cycle(&call,SYNCH_NO_TIMEOUT,SYNCH_BLOCKING);	349	callid = ipc_wait_cycle(&call, timeout, SYNCH_BLOCKING);
-		350
-		351	if (!callid) {
-		352	// handle_expired_timeouts.......;
-		353	continue;
-		354	}
343		355
344	if (callid & IPC_CALLID_ANSWERED)	356	if (callid & IPC_CALLID_ANSWERED)
345	continue;	357	continue;
346		358
347	handle_call(callid, &call);	359	handle_call(callid, &call);
348	}	360	}
349	}	361	}
350		362
351	/** Function to start async_manager as a standalone thread	363	/** Function to start async_manager as a standalone thread
352	*	364	*
353	* When more kernel threads are used, one async manager should	365	* When more kernel threads are used, one async manager should
354	* exist per thread. The particular implementation may change,	366	* exist per thread. The particular implementation may change,
355	* currently one async_manager is started automatically per kernel	367	* currently one async_manager is started automatically per kernel
356	* thread except main thread.	368	* thread except main thread.
357	*/	369	*/
358	static int async_manager_thread(void *arg)	370	static int async_manager_thread(void *arg)
359	{	371	{
360	futex_up(&async_futex); /* async_futex is always locked when entering	372	futex_up(&async_futex); /* async_futex is always locked when entering
361	* manager */	373	* manager */
362	async_manager();	374	async_manager();
363	}	375	}
364		376
365	/** Add one manager to manager list */	377	/** Add one manager to manager list */
366	void async_create_manager(void)	378	void async_create_manager(void)
367	{	379	{
368	pstid_t ptid;	380	pstid_t ptid;
369		381
370	ptid = psthread_create(async_manager_thread, NULL);	382	ptid = psthread_create(async_manager_thread, NULL);
371	psthread_add_manager(ptid);	383	psthread_add_manager(ptid);
372	}	384	}
373		385
374	/** Remove one manager from manager list */	386	/** Remove one manager from manager list */
375	void async_destroy_manager(void)	387	void async_destroy_manager(void)
376	{	388	{
377	psthread_remove_manager();	389	psthread_remove_manager();
378	}	390	}
379		391
380	/** Initialize internal structures needed for async manager */	392	/** Initialize internal structures needed for async manager */
381	int _async_init(void)	393	int _async_init(void)
382	{	394	{
383	if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_CHAINS, 1, &conn_hash_table_ops)) {	395	if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_CHAINS, 1, &conn_hash_table_ops)) {
384	printf("%s: cannot create hash table\n", "async");	396	printf("%s: cannot create hash table\n", "async");
385	return ENOMEM;	397	return ENOMEM;
386	}	398	}
387		399
388	}	400	}
389		401
390	/** IPC handler for messages in async framework	402	/** IPC handler for messages in async framework
391	*	403	*
392	* Notify thread that is waiting for this message, that it arrived	404	* Notify thread that is waiting for this message, that it arrived
393	*/	405	*/
394	static void reply_received(void *private, int retval,	406	static void reply_received(void *private, int retval,
395	ipc_call_t *data)	407	ipc_call_t *data)
396	{	408	{
397	amsg_t msg = (amsg_t ) private;	409	amsg_t msg = (amsg_t ) private;
398		410
399	msg->retval = retval;	411	msg->retval = retval;
400		412
401	futex_down(&async_futex);	413	futex_down(&async_futex);
402	/* Copy data after futex_down, just in case the	414	/* Copy data after futex_down, just in case the
403	* call was detached	415	* call was detached
404	*/	416	*/
405	if (msg->dataptr)	417	if (msg->dataptr)
406	msg->dataptr = data;	418	msg->dataptr = data;
407		419
-		420	/* TODO: memory barrier?? */
408	msg->done = 1;	421	msg->done = 1;
409	if (! msg->active) {	422	if (! msg->active) {
410	msg->active = 1;	423	msg->active = 1;
411	psthread_add_ready(msg->ptid);	424	psthread_add_ready(msg->ptid);
412	}	425	}
413	futex_up(&async_futex);	426	futex_up(&async_futex);
414	}	427	}
415		428
416	/** Send message and return id of the sent message	429	/** Send message and return id of the sent message
417	*	430	*
418	* The return value can be used as input for async_wait() to wait	431	* The return value can be used as input for async_wait() to wait
419	* for completion.	432	* for completion.
420	*/	433	*/
421	aid_t async_send_2(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,	434	aid_t async_send_2(int phoneid, ipcarg_t method, ipcarg_t arg1, ipcarg_t arg2,
422	ipc_call_t *dataptr)	435	ipc_call_t *dataptr)
423	{	436	{
424	amsg_t *msg;	437	amsg_t *msg;
425		438
426	msg = malloc(sizeof(*msg));	439	msg = malloc(sizeof(*msg));
427	msg->active = 1;	440	msg->active = 1;
428	msg->done = 0;	441	msg->done = 0;
429	msg->dataptr = dataptr;	442	msg->dataptr = dataptr;
430	ipc_call_async_2(phoneid,method,arg1,arg2,msg,reply_received);	443	ipc_call_async_2(phoneid,method,arg1,arg2,msg,reply_received);
431		444
432	return (aid_t) msg;	445	return (aid_t) msg;
433	}	446	}
434		447
435	/** Wait for a message sent by async framework	448	/** Wait for a message sent by async framework
436	*	449	*
437	* @param amsgid Message ID to wait for	450	* @param amsgid Message ID to wait for
438	* @param retval Pointer to variable where will be stored retval	451	* @param retval Pointer to variable where will be stored retval
439	* of the answered message. If NULL, it is ignored.	452	* of the answered message. If NULL, it is ignored.
440	*	453	*
441	*/	454	*/
442	void async_wait_for(aid_t amsgid, ipcarg_t *retval)	455	void async_wait_for(aid_t amsgid, ipcarg_t *retval)
443	{	456	{
444	amsg_t msg = (amsg_t ) amsgid;	457	amsg_t msg = (amsg_t ) amsgid;
445	connection_t *conn;	458	connection_t *conn;
446		459
447	futex_down(&async_futex);	460	futex_down(&async_futex);
448	if (msg->done) {	461	if (msg->done) {
449	futex_up(&async_futex);	462	futex_up(&async_futex);
450	goto done;	463	goto done;
451	}	464	}
452		465
453	msg->ptid = psthread_get_id();	466	msg->ptid = psthread_get_id();
454	msg->active = 0;	467	msg->active = 0;
455	/* Leave locked async_futex when entering this function */	468	/* Leave locked async_futex when entering this function */
456	psthread_schedule_next_adv(PS_TO_MANAGER);	469	psthread_schedule_next_adv(PS_TO_MANAGER);
457	/* futex is up automatically after psthread_schedule_next...*/	470	/* futex is up automatically after psthread_schedule_next...*/
458	done:	471	done:
459	if (retval)	472	if (retval)
460	*retval = msg->retval;	473	*retval = msg->retval;
461	free(msg);	474	free(msg);
462	}	475	}
-		476
-		477
-		478	/* int async_wait_timeout(aid_t amsgid, ipcarg_t retval, int timeout) /
-		479	/* { */
-		480	/* amsg_t msg = (amsg_t ) amsgid; */
-		481	/* connection_t conn; /
-		482
-		483	/* futex_down(&async_futex); */
-		484	/* if (msg->done) { */
-		485	/* futex_up(&async_futex); */
-		486	/* goto done; */
-		487	/* } */
-		488
-		489	/* msg->ptid = psthread_get_id(); */
-		490	/* msg->active = 0; */
-		491	/* msg->expires = gettime() + timeout; */
-		492	/* setup_timeouts_etc...(); */
-		493
-		494	/* /\* Leave locked async_futex when entering this function \/ /
-		495	/* psthread_schedule_next_adv(PS_TO_MANAGER); */
-		496	/* /\* futex is up automatically after psthread_schedule_next...\/ /
-		497
-		498	/* if (!msg->done) */
-		499	/* return casy-casy; */
-		500

Subversion Repositories HelenOS-historic

(root)/uspace/trunk/libc/generic/async.c – Rev 1427 → 1435