Changeset 8b655705 in mainline for uspace/lib/c/generic/async.c


Ignore:
Timestamp:
2011-04-15T19:38:07Z (13 years ago)
Author:
Jakub Jermar <jakub@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
9dd730d1
Parents:
6b9e85b (diff), b2fb47f (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge mainline changes.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • uspace/lib/c/generic/async.c

    r6b9e85b r8b655705  
    4343 * framework will automatically take care of most synchronization problems.
    4444 *
    45  * Default semantics:
    46  * - async_send_*(): Send asynchronously. If the kernel refuses to send
    47  *                   more messages, [ try to get responses from kernel, if
    48  *                   nothing found, might try synchronous ]
    49  *
    5045 * Example of use (pseudo C):
    5146 *
     
    5853 *   int fibril1(void *arg)
    5954 *   {
    60  *     conn = ipc_connect_me_to();
     55 *     conn = async_connect_me_to();
    6156 *     c1 = async_send(conn);
    6257 *     c2 = async_send(conn);
     
    7772 *   {
    7873 *     if (want_refuse) {
    79  *       ipc_answer_0(icallid, ELIMIT);
     74 *       async_answer_0(icallid, ELIMIT);
    8075 *       return;
    8176 *     }
    82  *     ipc_answer_0(icallid, EOK);
     77 *     async_answer_0(icallid, EOK);
    8378 *
    8479 *     callid = async_get_call(&call);
    8580 *     somehow_handle_the_call(callid, call);
    86  *     ipc_answer_2(callid, 1, 2, 3);
     81 *     async_answer_2(callid, 1, 2, 3);
    8782 *
    8883 *     callid = async_get_call(&call);
     
    9287 */
    9388
     89#define LIBC_ASYNC_C_
     90#include <ipc/ipc.h>
     91#include <async.h>
     92#undef LIBC_ASYNC_C_
     93
    9494#include <futex.h>
    95 #include <async.h>
    96 #include <async_priv.h>
    9795#include <fibril.h>
    9896#include <stdio.h>
    9997#include <adt/hash_table.h>
    10098#include <adt/list.h>
    101 #include <ipc/ipc.h>
    10299#include <assert.h>
    103100#include <errno.h>
     
    105102#include <arch/barrier.h>
    106103#include <bool.h>
     104#include "private/async.h"
    107105
    108106atomic_t async_futex = FUTEX_INITIALIZER;
     
    124122
    125123/**
    126  * Structures of this type are used to group information about a call and a
    127  * message queue link.
     124 * Structures of this type are used to group information about
     125 * a call and about a message queue link.
    128126 */
    129127typedef struct {
     
    134132
    135133typedef struct {
     134        sysarg_t in_task_hash;
     135        link_t link;
     136        int refcnt;
     137        void *data;
     138} client_t;
     139
     140typedef struct {
    136141        awaiter_t wdata;
    137142       
     
    139144        link_t link;
    140145       
     146        /** Incoming client task hash. */
     147        sysarg_t in_task_hash;
    141148        /** Incoming phone hash. */
    142149        sysarg_t in_phone_hash;
     150       
     151        /** Link to the client tracking structure. */
     152        client_t *client;
    143153       
    144154        /** Messages that should be delivered to this fibril. */
     
    158168
    159169/** Identifier of the incoming connection handled by the current fibril. */
    160 fibril_local connection_t *FIBRIL_connection;
    161 
    162 static void default_client_connection(ipc_callid_t callid, ipc_call_t *call);
    163 static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call);
     170static fibril_local connection_t *FIBRIL_connection;
     171
     172static void *default_client_data_constructor(void)
     173{
     174        return NULL;
     175}
     176
     177static void default_client_data_destructor(void *data)
     178{
     179}
     180
     181static async_client_data_ctor_t async_client_data_create =
     182    default_client_data_constructor;
     183static async_client_data_dtor_t async_client_data_destroy =
     184    default_client_data_destructor;
     185
     186void async_set_client_data_constructor(async_client_data_ctor_t ctor)
     187{
     188        async_client_data_create = ctor;
     189}
     190
     191void async_set_client_data_destructor(async_client_data_dtor_t dtor)
     192{
     193        async_client_data_destroy = dtor;
     194}
     195
     196void *async_client_data_get(void)
     197{
     198        assert(FIBRIL_connection);
     199        return FIBRIL_connection->client->data;
     200}
     201
     202/** Default fibril function that gets called to handle new connection.
     203 *
     204 * This function is defined as a weak symbol - to be redefined in user code.
     205 *
     206 * @param callid Hash of the incoming call.
     207 * @param call   Data of the incoming call.
     208 *
     209 */
     210static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)
     211{
     212        ipc_answer_0(callid, ENOENT);
     213}
    164214
    165215/**
     
    167217 */
    168218static async_client_conn_t client_connection = default_client_connection;
     219
     220/** Default fibril function that gets called to handle interrupt notifications.
     221 *
     222 * This function is defined as a weak symbol - to be redefined in user code.
     223 *
     224 * @param callid Hash of the incoming call.
     225 * @param call   Data of the incoming call.
     226 *
     227 */
     228static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call)
     229{
     230}
    169231
    170232/**
     
    174236static async_client_conn_t interrupt_received = default_interrupt_received;
    175237
     238static hash_table_t client_hash_table;
    176239static hash_table_t conn_hash_table;
    177240static LIST_INITIALIZE(timeout_list);
    178241
    179 #define CONN_HASH_TABLE_CHAINS  32
     242#define CLIENT_HASH_TABLE_BUCKETS  32
     243#define CONN_HASH_TABLE_BUCKETS    32
     244
     245static hash_index_t client_hash(unsigned long key[])
     246{
     247        assert(key);
     248        return (((key[0]) >> 4) % CLIENT_HASH_TABLE_BUCKETS);
     249}
     250
     251static int client_compare(unsigned long key[], hash_count_t keys, link_t *item)
     252{
     253        client_t *client = hash_table_get_instance(item, client_t, link);
     254        return (key[0] == client->in_task_hash);
     255}
     256
     257static void client_remove(link_t *item)
     258{
     259}
     260
     261/** Operations for the client hash table. */
     262static hash_table_operations_t client_hash_table_ops = {
     263        .hash = client_hash,
     264        .compare = client_compare,
     265        .remove_callback = client_remove
     266};
    180267
    181268/** Compute hash into the connection hash table based on the source phone hash.
     
    186273 *
    187274 */
    188 static hash_index_t conn_hash(unsigned long *key)
     275static hash_index_t conn_hash(unsigned long key[])
    189276{
    190277        assert(key);
    191         return (((*key) >> 4) % CONN_HASH_TABLE_CHAINS);
     278        return (((key[0]) >> 4) % CONN_HASH_TABLE_BUCKETS);
    192279}
    193280
     
    203290static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)
    204291{
    205         connection_t *hs = hash_table_get_instance(item, connection_t, link);
    206         return (key[0] == hs->in_phone_hash);
    207 }
    208 
    209 /** Connection hash table removal callback function.
    210  *
    211  * This function is called whenever a connection is removed from the connection
    212  * hash table.
    213  *
    214  * @param item Connection hash table item being removed.
    215  *
    216  */
     292        connection_t *conn = hash_table_get_instance(item, connection_t, link);
     293        return (key[0] == conn->in_phone_hash);
     294}
     295
    217296static void conn_remove(link_t *item)
    218297{
    219         free(hash_table_get_instance(item, connection_t, link));
    220 }
    221 
     298}
    222299
    223300/** Operations for the connection hash table. */
     
    240317        link_t *tmp = timeout_list.next;
    241318        while (tmp != &timeout_list) {
    242                 awaiter_t *cur;
    243                
    244                 cur = list_get_instance(tmp, awaiter_t, to_event.link);
     319                awaiter_t *cur
     320                    = list_get_instance(tmp, awaiter_t, to_event.link);
     321               
    245322                if (tv_gteq(&cur->to_event.expires, &wd->to_event.expires))
    246323                        break;
     324               
    247325                tmp = tmp->next;
    248326        }
     
    261339 *
    262340 * @return False if the call doesn't match any connection.
    263  *         True if the call was passed to the respective connection fibril.
     341 * @return True if the call was passed to the respective connection fibril.
    264342 *
    265343 */
     
    352430       
    353431        fid_t fid = fibril_create(notification_fibril, msg);
     432        if (fid == 0) {
     433                free(msg);
     434                futex_up(&async_futex);
     435                return false;
     436        }
     437       
    354438        fibril_add_ready(fid);
    355439       
     
    398482                         * the first IPC_M_PHONE_HUNGUP call and continues to
    399483                         * call async_get_call_timeout(). Repeat
    400                          * IPC_M_PHONE_HUNGUP until the caller notices. 
     484                         * IPC_M_PHONE_HUNGUP until the caller notices.
    401485                         */
    402486                        memset(call, 0, sizeof(ipc_call_t));
     
    405489                        return conn->close_callid;
    406490                }
    407 
     491               
    408492                if (usecs)
    409493                        async_insert_timeout(&conn->wdata);
     
    443527}
    444528
    445 /** Default fibril function that gets called to handle new connection.
    446  *
    447  * This function is defined as a weak symbol - to be redefined in user code.
    448  *
    449  * @param callid Hash of the incoming call.
    450  * @param call   Data of the incoming call.
    451  *
    452  */
    453 static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)
    454 {
    455         ipc_answer_0(callid, ENOENT);
    456 }
    457 
    458 /** Default fibril function that gets called to handle interrupt notifications.
    459  *
    460  * This function is defined as a weak symbol - to be redefined in user code.
    461  *
    462  * @param callid Hash of the incoming call.
    463  * @param call   Data of the incoming call.
    464  *
    465  */
    466 static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call)
    467 {
    468 }
    469 
    470529/** Wrapper for client connection fibril.
    471530 *
     
    481540{
    482541        /*
    483          * Setup fibril-local connection pointer and call client_connection().
    484          *
     542         * Setup fibril-local connection pointer.
    485543         */
    486544        FIBRIL_connection = (connection_t *) arg;
     545       
     546        futex_down(&async_futex);
     547       
     548        /*
     549         * Add our reference for the current connection in the client task
     550         * tracking structure. If this is the first reference, create and
     551         * hash in a new tracking structure.
     552         */
     553       
     554        unsigned long key = FIBRIL_connection->in_task_hash;
     555        link_t *lnk = hash_table_find(&client_hash_table, &key);
     556       
     557        client_t *client;
     558       
     559        if (lnk) {
     560                client = hash_table_get_instance(lnk, client_t, link);
     561                client->refcnt++;
     562        } else {
     563                client = malloc(sizeof(client_t));
     564                if (!client) {
     565                        ipc_answer_0(FIBRIL_connection->callid, ENOMEM);
     566                        futex_up(&async_futex);
     567                        return 0;
     568                }
     569               
     570                client->in_task_hash = FIBRIL_connection->in_task_hash;
     571               
     572                async_serialize_start();
     573                client->data = async_client_data_create();
     574                async_serialize_end();
     575               
     576                client->refcnt = 1;
     577                hash_table_insert(&client_hash_table, &key, &client->link);
     578        }
     579       
     580        futex_up(&async_futex);
     581       
     582        FIBRIL_connection->client = client;
     583       
     584        /*
     585         * Call the connection handler function.
     586         */
    487587        FIBRIL_connection->cfibril(FIBRIL_connection->callid,
    488588            &FIBRIL_connection->call);
    489589       
    490         /* Remove myself from the connection hash table */
     590        /*
     591         * Remove the reference for this client task connection.
     592         */
     593        bool destroy;
     594       
    491595        futex_down(&async_futex);
    492         unsigned long key = FIBRIL_connection->in_phone_hash;
     596       
     597        if (--client->refcnt == 0) {
     598                hash_table_remove(&client_hash_table, &key, 1);
     599                destroy = true;
     600        } else
     601                destroy = false;
     602       
     603        futex_up(&async_futex);
     604       
     605        if (destroy) {
     606                if (client->data)
     607                        async_client_data_destroy(client->data);
     608               
     609                free(client);
     610        }
     611       
     612        /*
     613         * Remove myself from the connection hash table.
     614         */
     615        futex_down(&async_futex);
     616        key = FIBRIL_connection->in_phone_hash;
    493617        hash_table_remove(&conn_hash_table, &key, 1);
    494618        futex_up(&async_futex);
    495619       
    496         /* Answer all remaining messages with EHANGUP */
     620        /*
     621         * Answer all remaining messages with EHANGUP.
     622         */
    497623        while (!list_empty(&FIBRIL_connection->msg_queue)) {
    498                 msg_t *msg;
    499                
    500                 msg = list_get_instance(FIBRIL_connection->msg_queue.next,
    501                     msg_t, link);
     624                msg_t *msg =
     625                    list_get_instance(FIBRIL_connection->msg_queue.next, msg_t,
     626                    link);
     627               
    502628                list_remove(&msg->link);
    503629                ipc_answer_0(msg->callid, EHANGUP);
     
    505631        }
    506632       
     633        /*
     634         * If the connection was hung-up, answer the last call,
     635         * i.e. IPC_M_PHONE_HUNGUP.
     636         */
    507637        if (FIBRIL_connection->close_callid)
    508638                ipc_answer_0(FIBRIL_connection->close_callid, EOK);
    509639       
     640        free(FIBRIL_connection);
    510641        return 0;
    511642}
     
    517648 * particular fibrils.
    518649 *
     650 * @param in_task_hash  Identification of the incoming connection.
    519651 * @param in_phone_hash Identification of the incoming connection.
    520652 * @param callid        Hash of the opening IPC_M_CONNECT_ME_TO call.
     
    529661 *
    530662 */
    531 fid_t async_new_connection(sysarg_t in_phone_hash, ipc_callid_t callid,
    532     ipc_call_t *call, void (*cfibril)(ipc_callid_t, ipc_call_t *))
     663fid_t async_new_connection(sysarg_t in_task_hash, sysarg_t in_phone_hash,
     664    ipc_callid_t callid, ipc_call_t *call,
     665    void (*cfibril)(ipc_callid_t, ipc_call_t *))
    533666{
    534667        connection_t *conn = malloc(sizeof(*conn));
     
    536669                if (callid)
    537670                        ipc_answer_0(callid, ENOMEM);
     671               
    538672                return (uintptr_t) NULL;
    539673        }
    540674       
     675        conn->in_task_hash = in_task_hash;
    541676        conn->in_phone_hash = in_phone_hash;
    542677        list_initialize(&conn->msg_queue);
     
    552687        conn->wdata.fid = fibril_create(connection_fibril, conn);
    553688       
    554         if (!conn->wdata.fid) {
     689        if (conn->wdata.fid == 0) {
    555690                free(conn);
     691               
    556692                if (callid)
    557693                        ipc_answer_0(callid, ENOMEM);
     694               
    558695                return (uintptr_t) NULL;
    559696        }
     
    582719static void handle_call(ipc_callid_t callid, ipc_call_t *call)
    583720{
    584         /* Unrouted call - do some default behaviour */
     721        /* Unrouted call - take some default action */
    585722        if ((callid & IPC_CALLID_NOTIFICATION)) {
    586723                process_notification(callid, call);
    587                 goto out;
     724                return;
    588725        }
    589726       
     
    591728        case IPC_M_CONNECT_ME:
    592729        case IPC_M_CONNECT_ME_TO:
    593                 /* Open new connection with fibril etc. */
    594                 async_new_connection(IPC_GET_ARG5(*call), callid, call,
    595                     client_connection);
    596                 goto out;
     730                /* Open new connection with fibril, etc. */
     731                async_new_connection(call->in_task_hash, IPC_GET_ARG5(*call),
     732                    callid, call, client_connection);
     733                return;
    597734        }
    598735       
    599736        /* Try to route the call through the connection hash table */
    600737        if (route_call(callid, call))
    601                 goto out;
     738                return;
    602739       
    603740        /* Unknown call from unknown phone - hang it up */
    604741        ipc_answer_0(callid, EHANGUP);
    605         return;
    606        
    607 out:
    608         ;
    609742}
    610743
     
    619752        link_t *cur = timeout_list.next;
    620753        while (cur != &timeout_list) {
    621                 awaiter_t *waiter;
    622                
    623                 waiter = list_get_instance(cur, awaiter_t, to_event.link);
     754                awaiter_t *waiter =
     755                    list_get_instance(cur, awaiter_t, to_event.link);
     756               
    624757                if (tv_gt(&waiter->to_event.expires, &tv))
    625758                        break;
    626 
     759               
    627760                cur = cur->next;
    628 
     761               
    629762                list_remove(&waiter->to_event.link);
    630763                waiter->to_event.inlist = false;
     
    653786        while (true) {
    654787                if (fibril_switch(FIBRIL_FROM_MANAGER)) {
    655                         futex_up(&async_futex); 
     788                        futex_up(&async_futex);
    656789                        /*
    657790                         * async_futex is always held when entering a manager
     
    676809                                continue;
    677810                        } else
    678                                 timeout = tv_sub(&waiter->to_event.expires,
    679                                     &tv);
     811                                timeout = tv_sub(&waiter->to_event.expires, &tv);
    680812                } else
    681813                        timeout = SYNCH_NO_TIMEOUT;
    682814               
    683815                futex_up(&async_futex);
    684 
     816               
    685817                atomic_inc(&threads_in_ipc_wait);
    686818               
     
    690822               
    691823                atomic_dec(&threads_in_ipc_wait);
    692 
     824               
    693825                if (!callid) {
    694826                        handle_expired_timeouts();
     
    729861{
    730862        fid_t fid = fibril_create(async_manager_fibril, NULL);
    731         fibril_add_manager(fid);
     863        if (fid != 0)
     864                fibril_add_manager(fid);
    732865}
    733866
     
    740873/** Initialize the async framework.
    741874 *
    742  * @return Zero on success or an error code.
    743  */
    744 int __async_init(void)
    745 {
    746         if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_CHAINS, 1,
    747             &conn_hash_table_ops)) {
    748                 printf("%s: Cannot create async hash table\n", "libc");
    749                 return ENOMEM;
    750         }
    751 
    752         _async_sess_init();
    753        
    754         return 0;
     875 */
     876void __async_init(void)
     877{
     878        if (!hash_table_create(&client_hash_table, CLIENT_HASH_TABLE_BUCKETS, 1,
     879            &client_hash_table_ops))
     880                abort();
     881       
     882        if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_BUCKETS, 1,
     883            &conn_hash_table_ops))
     884                abort();
    755885}
    756886
     
    765895 * @param retval Value returned in the answer.
    766896 * @param data   Call data of the answer.
     897 *
    767898 */
    768899static void reply_received(void *arg, int retval, ipc_call_t *data)
     
    812943    sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, ipc_call_t *dataptr)
    813944{
    814         amsg_t *msg = malloc(sizeof(*msg));
     945        amsg_t *msg = malloc(sizeof(amsg_t));
    815946       
    816947        if (!msg)
     
    821952       
    822953        msg->wdata.to_event.inlist = false;
    823         /* We may sleep in the next method, but it will use its own mechanism */
     954       
     955        /*
     956         * We may sleep in the next method,
     957         * but it will use its own means
     958         */
    824959        msg->wdata.active = true;
    825960       
     
    852987    ipc_call_t *dataptr)
    853988{
    854         amsg_t *msg = malloc(sizeof(*msg));
     989        amsg_t *msg = malloc(sizeof(amsg_t));
    855990       
    856991        if (!msg)
     
    861996       
    862997        msg->wdata.to_event.inlist = false;
    863         /* We may sleep in next method, but it will use its own mechanism */
     998       
     999        /*
     1000         * We may sleep in the next method,
     1001         * but it will use its own means
     1002         */
    8641003        msg->wdata.active = true;
    8651004       
     
    9601099void async_usleep(suseconds_t timeout)
    9611100{
    962         amsg_t *msg = malloc(sizeof(*msg));
     1101        amsg_t *msg = malloc(sizeof(amsg_t));
    9631102       
    9641103        if (!msg)
     
    11031242}
    11041243
     1244void async_msg_0(int phone, sysarg_t imethod)
     1245{
     1246        ipc_call_async_0(phone, imethod, NULL, NULL, true);
     1247}
     1248
     1249void async_msg_1(int phone, sysarg_t imethod, sysarg_t arg1)
     1250{
     1251        ipc_call_async_1(phone, imethod, arg1, NULL, NULL, true);
     1252}
     1253
     1254void async_msg_2(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2)
     1255{
     1256        ipc_call_async_2(phone, imethod, arg1, arg2, NULL, NULL, true);
     1257}
     1258
     1259void async_msg_3(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2,
     1260    sysarg_t arg3)
     1261{
     1262        ipc_call_async_3(phone, imethod, arg1, arg2, arg3, NULL, NULL, true);
     1263}
     1264
     1265void async_msg_4(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2,
     1266    sysarg_t arg3, sysarg_t arg4)
     1267{
     1268        ipc_call_async_4(phone, imethod, arg1, arg2, arg3, arg4, NULL, NULL,
     1269            true);
     1270}
     1271
     1272void async_msg_5(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2,
     1273    sysarg_t arg3, sysarg_t arg4, sysarg_t arg5)
     1274{
     1275        ipc_call_async_5(phone, imethod, arg1, arg2, arg3, arg4, arg5, NULL,
     1276            NULL, true);
     1277}
     1278
     1279sysarg_t async_answer_0(ipc_callid_t callid, sysarg_t retval)
     1280{
     1281        return ipc_answer_0(callid, retval);
     1282}
     1283
     1284sysarg_t async_answer_1(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1)
     1285{
     1286        return ipc_answer_1(callid, retval, arg1);
     1287}
     1288
     1289sysarg_t async_answer_2(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1290    sysarg_t arg2)
     1291{
     1292        return ipc_answer_2(callid, retval, arg1, arg2);
     1293}
     1294
     1295sysarg_t async_answer_3(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1296    sysarg_t arg2, sysarg_t arg3)
     1297{
     1298        return ipc_answer_3(callid, retval, arg1, arg2, arg3);
     1299}
     1300
     1301sysarg_t async_answer_4(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1302    sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
     1303{
     1304        return ipc_answer_4(callid, retval, arg1, arg2, arg3, arg4);
     1305}
     1306
     1307sysarg_t async_answer_5(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1308    sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5)
     1309{
     1310        return ipc_answer_5(callid, retval, arg1, arg2, arg3, arg4, arg5);
     1311}
     1312
     1313int async_forward_fast(ipc_callid_t callid, int phoneid, sysarg_t imethod,
     1314    sysarg_t arg1, sysarg_t arg2, unsigned int mode)
     1315{
     1316        return ipc_forward_fast(callid, phoneid, imethod, arg1, arg2, mode);
     1317}
     1318
     1319int async_forward_slow(ipc_callid_t callid, int phoneid, sysarg_t imethod,
     1320    sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5,
     1321    unsigned int mode)
     1322{
     1323        return ipc_forward_slow(callid, phoneid, imethod, arg1, arg2, arg3, arg4,
     1324            arg5, mode);
     1325}
     1326
     1327/** Wrapper for making IPC_M_CONNECT_TO_ME calls using the async framework.
     1328 *
     1329 * Ask through phone for a new connection to some service.
     1330 *
     1331 * @param phone           Phone handle used for contacting the other side.
     1332 * @param arg1            User defined argument.
     1333 * @param arg2            User defined argument.
     1334 * @param arg3            User defined argument.
     1335 * @param client_receiver Connection handing routine.
     1336 *
     1337 * @return New phone handle on success or a negative error code.
     1338 *
     1339 */
     1340int async_connect_to_me(int phone, sysarg_t arg1, sysarg_t arg2,
     1341    sysarg_t arg3, async_client_conn_t client_receiver)
     1342{
     1343        sysarg_t task_hash;
     1344        sysarg_t phone_hash;
     1345        int rc = async_req_3_5(phone, IPC_M_CONNECT_TO_ME, arg1, arg2, arg3,
     1346            NULL, NULL, NULL, &task_hash, &phone_hash);
     1347        if (rc != EOK)
     1348                return rc;
     1349       
     1350        if (client_receiver != NULL)
     1351                async_new_connection(task_hash, phone_hash, 0, NULL,
     1352                    client_receiver);
     1353       
     1354        return EOK;
     1355}
     1356
    11051357/** Wrapper for making IPC_M_CONNECT_ME_TO calls using the async framework.
    1106  * 
     1358 *
    11071359 * Ask through phone for a new connection to some service.
    11081360 *
    1109  * @param phoneid       Phone handle used for contacting the other side.
    1110  * @param arg1          User defined argument.
    1111  * @param arg2          User defined argument.
    1112  * @param arg3          User defined argument.
    1113  *
    1114  * @return              New phone handle on success or a negative error code.
    1115  */
    1116 int
    1117 async_connect_me_to(int phoneid, sysarg_t arg1, sysarg_t arg2, sysarg_t arg3)
    1118 {
    1119         int rc;
     1361 * @param phone Phone handle used for contacting the other side.
     1362 * @param arg1  User defined argument.
     1363 * @param arg2  User defined argument.
     1364 * @param arg3  User defined argument.
     1365 *
     1366 * @return New phone handle on success or a negative error code.
     1367 *
     1368 */
     1369int async_connect_me_to(int phone, sysarg_t arg1, sysarg_t arg2,
     1370    sysarg_t arg3)
     1371{
    11201372        sysarg_t newphid;
    1121 
    1122         rc = async_req_3_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3, NULL,
    1123             NULL, NULL, NULL, &newphid);
    1124        
    1125         if (rc != EOK) 
     1373        int rc = async_req_3_5(phone, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3,
     1374            NULL, NULL, NULL, NULL, &newphid);
     1375       
     1376        if (rc != EOK)
    11261377                return rc;
    1127 
     1378       
    11281379        return newphid;
    11291380}
    11301381
    11311382/** Wrapper for making IPC_M_CONNECT_ME_TO calls using the async framework.
    1132  * 
     1383 *
    11331384 * Ask through phone for a new connection to some service and block until
    11341385 * success.
    11351386 *
    1136  * @param phoneid       Phone handle used for contacting the other side.
    1137  * @param arg1          User defined argument.
    1138  * @param arg2          User defined argument.
    1139  * @param arg3          User defined argument.
    1140  *
    1141  * @return              New phone handle on success or a negative error code.
    1142  */
    1143 int
    1144 async_connect_me_to_blocking(int phoneid, sysarg_t arg1, sysarg_t arg2,
     1387 * @param phoneid Phone handle used for contacting the other side.
     1388 * @param arg1    User defined argument.
     1389 * @param arg2    User defined argument.
     1390 * @param arg3    User defined argument.
     1391 *
     1392 * @return New phone handle on success or a negative error code.
     1393 *
     1394 */
     1395int async_connect_me_to_blocking(int phoneid, sysarg_t arg1, sysarg_t arg2,
    11451396    sysarg_t arg3)
    11461397{
    1147         int rc;
    11481398        sysarg_t newphid;
    1149 
    1150         rc = async_req_4_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3,
     1399        int rc = async_req_4_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3,
    11511400            IPC_FLAG_BLOCKING, NULL, NULL, NULL, NULL, &newphid);
    11521401       
    1153         if (rc != EOK) 
     1402        if (rc != EOK)
    11541403                return rc;
    1155 
     1404       
    11561405        return newphid;
    11571406}
    11581407
    1159 /** Wrapper for making IPC_M_SHARE_IN calls using the async framework.
    1160  *
    1161  * @param phoneid       Phone that will be used to contact the receiving side.
    1162  * @param dst           Destination address space area base.
    1163  * @param size          Size of the destination address space area.
    1164  * @param arg           User defined argument.
    1165  * @param flags         Storage where the received flags will be stored. Can be
    1166  *                      NULL.
    1167  *
    1168  * @return              Zero on success or a negative error code from errno.h.
     1408/** Connect to a task specified by id.
     1409 *
     1410 */
     1411int async_connect_kbox(task_id_t id)
     1412{
     1413        return ipc_connect_kbox(id);
     1414}
     1415
     1416/** Wrapper for ipc_hangup.
     1417 *
     1418 * @param phone Phone handle to hung up.
     1419 *
     1420 * @return Zero on success or a negative error code.
     1421 *
     1422 */
     1423int async_hangup(int phone)
     1424{
     1425        return ipc_hangup(phone);
     1426}
     1427
     1428/** Interrupt one thread of this task from waiting for IPC. */
     1429void async_poke(void)
     1430{
     1431        ipc_poke();
     1432}
     1433
     1434/** Wrapper for IPC_M_SHARE_IN calls using the async framework.
     1435 *
     1436 * @param phoneid Phone that will be used to contact the receiving side.
     1437 * @param dst     Destination address space area base.
     1438 * @param size    Size of the destination address space area.
     1439 * @param arg     User defined argument.
     1440 * @param flags   Storage for the received flags. Can be NULL.
     1441 *
     1442 * @return Zero on success or a negative error code from errno.h.
     1443 *
    11691444 */
    11701445int async_share_in_start(int phoneid, void *dst, size_t size, sysarg_t arg,
    1171     int *flags)
    1172 {
    1173         int res;
     1446    unsigned int *flags)
     1447{
    11741448        sysarg_t tmp_flags;
    1175         res = async_req_3_2(phoneid, IPC_M_SHARE_IN, (sysarg_t) dst,
     1449        int res = async_req_3_2(phoneid, IPC_M_SHARE_IN, (sysarg_t) dst,
    11761450            (sysarg_t) size, arg, NULL, &tmp_flags);
     1451       
    11771452        if (flags)
    1178                 *flags = tmp_flags;
     1453                *flags = (unsigned int) tmp_flags;
     1454       
    11791455        return res;
    11801456}
     
    11821458/** Wrapper for receiving the IPC_M_SHARE_IN calls using the async framework.
    11831459 *
    1184  * This wrapper only makes it more comfortable to receive IPC_M_SHARE_IN calls
    1185  * so that the user doesn't have to remember the meaning of each IPC argument.
     1460 * This wrapper only makes it more comfortable to receive IPC_M_SHARE_IN
     1461 * calls so that the user doesn't have to remember the meaning of each IPC
     1462 * argument.
    11861463 *
    11871464 * So far, this wrapper is to be used from within a connection fibril.
    11881465 *
    1189  * @param callid        Storage where the hash of the IPC_M_SHARE_IN call will
    1190  *                      be stored.
    1191  * @param size          Destination address space area size.   
    1192  *
    1193  * @return              Non-zero on success, zero on failure.
    1194  */
    1195 int async_share_in_receive(ipc_callid_t *callid, size_t *size)
    1196 {
    1197         ipc_call_t data;
    1198        
     1466 * @param callid Storage for the hash of the IPC_M_SHARE_IN call.
     1467 * @param size   Destination address space area size.
     1468 *
     1469 * @return True on success, false on failure.
     1470 *
     1471 */
     1472bool async_share_in_receive(ipc_callid_t *callid, size_t *size)
     1473{
    11991474        assert(callid);
    12001475        assert(size);
    1201 
     1476       
     1477        ipc_call_t data;
    12021478        *callid = async_get_call(&data);
     1479       
    12031480        if (IPC_GET_IMETHOD(data) != IPC_M_SHARE_IN)
    1204                 return 0;
     1481                return false;
     1482       
    12051483        *size = (size_t) IPC_GET_ARG2(data);
    1206         return 1;
     1484        return true;
    12071485}
    12081486
    12091487/** Wrapper for answering the IPC_M_SHARE_IN calls using the async framework.
    12101488 *
    1211  * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ calls
    1212  * so that the user doesn't have to remember the meaning of each IPC argument.
    1213  *
    1214  * @param callid        Hash of the IPC_M_DATA_READ call to answer.
    1215  * @param src           Source address space base.
    1216  * @param flags         Flags to be used for sharing. Bits can be only cleared.
    1217  *
    1218  * @return              Zero on success or a value from @ref errno.h on failure.
    1219  */
    1220 int async_share_in_finalize(ipc_callid_t callid, void *src, int flags)
     1489 * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ
     1490 * calls so that the user doesn't have to remember the meaning of each IPC
     1491 * argument.
     1492 *
     1493 * @param callid Hash of the IPC_M_DATA_READ call to answer.
     1494 * @param src    Source address space base.
     1495 * @param flags  Flags to be used for sharing. Bits can be only cleared.
     1496 *
     1497 * @return Zero on success or a value from @ref errno.h on failure.
     1498 *
     1499 */
     1500int async_share_in_finalize(ipc_callid_t callid, void *src, unsigned int flags)
    12211501{
    12221502        return ipc_share_in_finalize(callid, src, flags);
    12231503}
    12241504
    1225 /** Wrapper for making IPC_M_SHARE_OUT calls using the async framework.
    1226  *
    1227  * @param phoneid       Phone that will be used to contact the receiving side.
    1228  * @param src           Source address space area base address.
    1229  * @param flags         Flags to be used for sharing. Bits can be only cleared.
    1230  *
    1231  * @return              Zero on success or a negative error code from errno.h.
    1232  */
    1233 int async_share_out_start(int phoneid, void *src, int flags)
     1505/** Wrapper for IPC_M_SHARE_OUT calls using the async framework.
     1506 *
     1507 * @param phoneid Phone that will be used to contact the receiving side.
     1508 * @param src     Source address space area base address.
     1509 * @param flags   Flags to be used for sharing. Bits can be only cleared.
     1510 *
     1511 * @return Zero on success or a negative error code from errno.h.
     1512 *
     1513 */
     1514int async_share_out_start(int phoneid, void *src, unsigned int flags)
    12341515{
    12351516        return async_req_3_0(phoneid, IPC_M_SHARE_OUT, (sysarg_t) src, 0,
     
    12391520/** Wrapper for receiving the IPC_M_SHARE_OUT calls using the async framework.
    12401521 *
    1241  * This wrapper only makes it more comfortable to receive IPC_M_SHARE_OUT calls
    1242  * so that the user doesn't have to remember the meaning of each IPC argument.
     1522 * This wrapper only makes it more comfortable to receive IPC_M_SHARE_OUT
     1523 * calls so that the user doesn't have to remember the meaning of each IPC
     1524 * argument.
    12431525 *
    12441526 * So far, this wrapper is to be used from within a connection fibril.
    12451527 *
    1246  * @param callid        Storage where the hash of the IPC_M_SHARE_OUT call will
    1247  *                      be stored.
    1248  * @param size          Storage where the source address space area size will be
    1249  *                      stored.
    1250  * @param flags         Storage where the sharing flags will be stored.
    1251  *
    1252  * @return              Non-zero on success, zero on failure.
    1253  */
    1254 int async_share_out_receive(ipc_callid_t *callid, size_t *size, int *flags)
    1255 {
    1256         ipc_call_t data;
    1257        
     1528 * @param callid Storage for the hash of the IPC_M_SHARE_OUT call.
     1529 * @param size   Storage for the source address space area size.
     1530 * @param flags  Storage for the sharing flags.
     1531 *
     1532 * @return True on success, false on failure.
     1533 *
     1534 */
     1535bool async_share_out_receive(ipc_callid_t *callid, size_t *size, unsigned int *flags)
     1536{
    12581537        assert(callid);
    12591538        assert(size);
    12601539        assert(flags);
    1261 
     1540       
     1541        ipc_call_t data;
    12621542        *callid = async_get_call(&data);
     1543       
    12631544        if (IPC_GET_IMETHOD(data) != IPC_M_SHARE_OUT)
    1264                 return 0;
     1545                return false;
     1546       
    12651547        *size = (size_t) IPC_GET_ARG2(data);
    1266         *flags = (int) IPC_GET_ARG3(data);
    1267         return 1;
     1548        *flags = (unsigned int) IPC_GET_ARG3(data);
     1549        return true;
    12681550}
    12691551
    12701552/** Wrapper for answering the IPC_M_SHARE_OUT calls using the async framework.
    12711553 *
    1272  * This wrapper only makes it more comfortable to answer IPC_M_SHARE_OUT calls
    1273  * so that the user doesn't have to remember the meaning of each IPC argument.
    1274  *
    1275  * @param callid        Hash of the IPC_M_DATA_WRITE call to answer.
    1276  * @param dst           Destination address space area base address.   
    1277  *
    1278  * @return              Zero on success or a value from @ref errno.h on failure.
     1554 * This wrapper only makes it more comfortable to answer IPC_M_SHARE_OUT
     1555 * calls so that the user doesn't have to remember the meaning of each IPC
     1556 * argument.
     1557 *
     1558 * @param callid Hash of the IPC_M_DATA_WRITE call to answer.
     1559 * @param dst    Destination address space area base address.
     1560 *
     1561 * @return Zero on success or a value from @ref errno.h on failure.
     1562 *
    12791563 */
    12801564int async_share_out_finalize(ipc_callid_t callid, void *dst)
     
    12831567}
    12841568
    1285 
    1286 /** Wrapper for making IPC_M_DATA_READ calls using the async framework.
    1287  *
    1288  * @param phoneid       Phone that will be used to contact the receiving side.
    1289  * @param dst           Address of the beginning of the destination buffer.
    1290  * @param size          Size of the destination buffer.
    1291  *
    1292  * @return              Zero on success or a negative error code from errno.h.
    1293  */
    1294 int async_data_read_start(int phoneid, void *dst, size_t size)
    1295 {
    1296         return async_req_2_0(phoneid, IPC_M_DATA_READ, (sysarg_t) dst,
    1297             (sysarg_t) size);
     1569/** Wrapper for IPC_M_DATA_READ calls using the async framework.
     1570 *
     1571 * @param phoneid Phone that will be used to contact the receiving side.
     1572 * @param dst     Address of the beginning of the destination buffer.
     1573 * @param size    Size of the destination buffer.
     1574 * @param flags   Flags to control the data transfer.
     1575 *
     1576 * @return Zero on success or a negative error code from errno.h.
     1577 *
     1578 */
     1579int
     1580async_data_read_start_generic(int phoneid, void *dst, size_t size, int flags)
     1581{
     1582        return async_req_3_0(phoneid, IPC_M_DATA_READ, (sysarg_t) dst,
     1583            (sysarg_t) size, (sysarg_t) flags);
    12981584}
    12991585
    13001586/** Wrapper for receiving the IPC_M_DATA_READ calls using the async framework.
    13011587 *
    1302  * This wrapper only makes it more comfortable to receive IPC_M_DATA_READ calls
    1303  * so that the user doesn't have to remember the meaning of each IPC argument.
     1588 * This wrapper only makes it more comfortable to receive IPC_M_DATA_READ
     1589 * calls so that the user doesn't have to remember the meaning of each IPC
     1590 * argument.
    13041591 *
    13051592 * So far, this wrapper is to be used from within a connection fibril.
    13061593 *
    1307  * @param callid        Storage where the hash of the IPC_M_DATA_READ call will
    1308  *                      be stored.
    1309  * @param size          Storage where the maximum size will be stored. Can be
    1310  *                      NULL.
    1311  *
    1312  * @return              Non-zero on success, zero on failure.
    1313  */
    1314 int async_data_read_receive(ipc_callid_t *callid, size_t *size)
    1315 {
     1594 * @param callid Storage for the hash of the IPC_M_DATA_READ.
     1595 * @param size   Storage for the maximum size. Can be NULL.
     1596 *
     1597 * @return True on success, false on failure.
     1598 *
     1599 */
     1600bool async_data_read_receive(ipc_callid_t *callid, size_t *size)
     1601{
     1602        assert(callid);
     1603       
    13161604        ipc_call_t data;
    1317        
    1318         assert(callid);
    1319 
    13201605        *callid = async_get_call(&data);
     1606       
    13211607        if (IPC_GET_IMETHOD(data) != IPC_M_DATA_READ)
    1322                 return 0;
     1608                return false;
     1609       
    13231610        if (size)
    13241611                *size = (size_t) IPC_GET_ARG2(data);
    1325         return 1;
     1612       
     1613        return true;
    13261614}
    13271615
    13281616/** Wrapper for answering the IPC_M_DATA_READ calls using the async framework.
    13291617 *
    1330  * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ calls
    1331  * so that the user doesn't have to remember the meaning of each IPC argument.
    1332  *
    1333  * @param callid        Hash of the IPC_M_DATA_READ call to answer.
    1334  * @param src           Source address for the IPC_M_DATA_READ call.
    1335  * @param size          Size for the IPC_M_DATA_READ call. Can be smaller than
    1336  *                      the maximum size announced by the sender.
    1337  *
    1338  * @return              Zero on success or a value from @ref errno.h on failure.
     1618 * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ
     1619 * calls so that the user doesn't have to remember the meaning of each IPC
     1620 * argument.
     1621 *
     1622 * @param callid Hash of the IPC_M_DATA_READ call to answer.
     1623 * @param src    Source address for the IPC_M_DATA_READ call.
     1624 * @param size   Size for the IPC_M_DATA_READ call. Can be smaller than
     1625 *               the maximum size announced by the sender.
     1626 *
     1627 * @return Zero on success or a value from @ref errno.h on failure.
     1628 *
    13391629 */
    13401630int async_data_read_finalize(ipc_callid_t callid, const void *src, size_t size)
     
    13441634
    13451635/** Wrapper for forwarding any read request
    1346  *
    13471636 *
    13481637 */
     
    13771666}
    13781667
    1379 /** Wrapper for making IPC_M_DATA_WRITE calls using the async framework.
     1668/** Wrapper for IPC_M_DATA_WRITE calls using the async framework.
    13801669 *
    13811670 * @param phoneid Phone that will be used to contact the receiving side.
    13821671 * @param src     Address of the beginning of the source buffer.
    13831672 * @param size    Size of the source buffer.
     1673 * @param flags   Flags to control the data transfer.
    13841674 *
    13851675 * @return Zero on success or a negative error code from errno.h.
    13861676 *
    13871677 */
    1388 int async_data_write_start(int phoneid, const void *src, size_t size)
    1389 {
    1390         return async_req_2_0(phoneid, IPC_M_DATA_WRITE, (sysarg_t) src,
    1391             (sysarg_t) size);
     1678int
     1679async_data_write_start_generic(int phoneid, const void *src, size_t size,
     1680    int flags)
     1681{
     1682        return async_req_3_0(phoneid, IPC_M_DATA_WRITE, (sysarg_t) src,
     1683            (sysarg_t) size, (sysarg_t) flags);
    13921684}
    13931685
    13941686/** Wrapper for receiving the IPC_M_DATA_WRITE calls using the async framework.
    13951687 *
    1396  * This wrapper only makes it more comfortable to receive IPC_M_DATA_WRITE calls
    1397  * so that the user doesn't have to remember the meaning of each IPC argument.
     1688 * This wrapper only makes it more comfortable to receive IPC_M_DATA_WRITE
     1689 * calls so that the user doesn't have to remember the meaning of each IPC
     1690 * argument.
    13981691 *
    13991692 * So far, this wrapper is to be used from within a connection fibril.
    14001693 *
    1401  * @param callid Storage where the hash of the IPC_M_DATA_WRITE call will
    1402  *               be stored.
    1403  * @param size   Storage where the suggested size will be stored. May be
    1404  *               NULL
    1405  *
    1406  * @return Non-zero on success, zero on failure.
    1407  *
    1408  */
    1409 int async_data_write_receive(ipc_callid_t *callid, size_t *size)
    1410 {
     1694 * @param callid Storage for the hash of the IPC_M_DATA_WRITE.
     1695 * @param size   Storage for the suggested size. May be NULL.
     1696 *
     1697 * @return True on success, false on failure.
     1698 *
     1699 */
     1700bool async_data_write_receive(ipc_callid_t *callid, size_t *size)
     1701{
     1702        assert(callid);
     1703       
    14111704        ipc_call_t data;
    1412        
    1413         assert(callid);
    1414        
    14151705        *callid = async_get_call(&data);
     1706       
    14161707        if (IPC_GET_IMETHOD(data) != IPC_M_DATA_WRITE)
    1417                 return 0;
     1708                return false;
    14181709       
    14191710        if (size)
    14201711                *size = (size_t) IPC_GET_ARG2(data);
    14211712       
    1422         return 1;
     1713        return true;
    14231714}
    14241715
    14251716/** Wrapper for answering the IPC_M_DATA_WRITE calls using the async framework.
    14261717 *
    1427  * This wrapper only makes it more comfortable to answer IPC_M_DATA_WRITE calls
    1428  * so that the user doesn't have to remember the meaning of each IPC argument.
     1718 * This wrapper only makes it more comfortable to answer IPC_M_DATA_WRITE
     1719 * calls so that the user doesn't have to remember the meaning of each IPC
     1720 * argument.
    14291721 *
    14301722 * @param callid Hash of the IPC_M_DATA_WRITE call to answer.
     
    15221814 *
    15231815 */
    1524 void async_data_write_void(const int retval)
     1816void async_data_write_void(sysarg_t retval)
    15251817{
    15261818        ipc_callid_t callid;
     
    15301822
    15311823/** Wrapper for forwarding any data that is about to be received
    1532  *
    15331824 *
    15341825 */
Note: See TracChangeset for help on using the changeset viewer.