Ignore:
File:
1 edited

Legend:

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

    r23882034 r9c31643  
    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 {
     
    153151        /** Link to the client tracking structure. */
    154152        client_t *client;
    155 
     153       
    156154        /** Messages that should be delivered to this fibril. */
    157155        link_t msg_queue;
     
    170168
    171169/** Identifier of the incoming connection handled by the current fibril. */
    172 fibril_local connection_t *FIBRIL_connection;
     170static fibril_local connection_t *FIBRIL_connection;
    173171
    174172static void *default_client_data_constructor(void)
     
    199197{
    200198        assert(FIBRIL_connection);
    201 
    202199        return FIBRIL_connection->client->data;
    203200}
    204201
    205 static void default_client_connection(ipc_callid_t callid, ipc_call_t *call);
    206 static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call);
     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}
    207214
    208215/**
     
    210217 */
    211218static 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}
    212231
    213232/**
     
    221240static LIST_INITIALIZE(timeout_list);
    222241
    223 #define CLIENT_HASH_TABLE_BUCKETS       32
    224 #define CONN_HASH_TABLE_BUCKETS         32
    225 
    226 static hash_index_t client_hash(unsigned long *key)
     242#define CLIENT_HASH_TABLE_BUCKETS  32
     243#define CONN_HASH_TABLE_BUCKETS    32
     244
     245static hash_index_t client_hash(unsigned long key[])
    227246{
    228247        assert(key);
    229         return (((*key) >> 4) % CLIENT_HASH_TABLE_BUCKETS);
     248        return (((key[0]) >> 4) % CLIENT_HASH_TABLE_BUCKETS);
    230249}
    231250
    232251static int client_compare(unsigned long key[], hash_count_t keys, link_t *item)
    233252{
    234         client_t *cl = hash_table_get_instance(item, client_t, link);
    235         return (key[0] == cl->in_task_hash);
     253        client_t *client = hash_table_get_instance(item, client_t, link);
     254        return (key[0] == client->in_task_hash);
    236255}
    237256
     
    254273 *
    255274 */
    256 static hash_index_t conn_hash(unsigned long *key)
     275static hash_index_t conn_hash(unsigned long key[])
    257276{
    258277        assert(key);
    259         return (((*key) >> 4) % CONN_HASH_TABLE_BUCKETS);
     278        return (((key[0]) >> 4) % CONN_HASH_TABLE_BUCKETS);
    260279}
    261280
     
    271290static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)
    272291{
    273         connection_t *hs = hash_table_get_instance(item, connection_t, link);
    274         return (key[0] == hs->in_phone_hash);
    275 }
    276 
    277 /** Connection hash table removal callback function.
    278  *
    279  * This function is called whenever a connection is removed from the connection
    280  * hash table.
    281  *
    282  * @param item Connection hash table item being removed.
    283  *
    284  */
     292        connection_t *conn = hash_table_get_instance(item, connection_t, link);
     293        return (key[0] == conn->in_phone_hash);
     294}
     295
    285296static void conn_remove(link_t *item)
    286297{
    287         free(hash_table_get_instance(item, connection_t, link));
    288 }
    289 
     298}
    290299
    291300/** Operations for the connection hash table. */
     
    308317        link_t *tmp = timeout_list.next;
    309318        while (tmp != &timeout_list) {
    310                 awaiter_t *cur;
    311                
    312                 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               
    313322                if (tv_gteq(&cur->to_event.expires, &wd->to_event.expires))
    314323                        break;
     324               
    315325                tmp = tmp->next;
    316326        }
     
    329339 *
    330340 * @return False if the call doesn't match any connection.
    331  *         True if the call was passed to the respective connection fibril.
     341 * @return True if the call was passed to the respective connection fibril.
    332342 *
    333343 */
     
    466476                         * the first IPC_M_PHONE_HUNGUP call and continues to
    467477                         * call async_get_call_timeout(). Repeat
    468                          * IPC_M_PHONE_HUNGUP until the caller notices. 
     478                         * IPC_M_PHONE_HUNGUP until the caller notices.
    469479                         */
    470480                        memset(call, 0, sizeof(ipc_call_t));
     
    473483                        return conn->close_callid;
    474484                }
    475 
     485               
    476486                if (usecs)
    477487                        async_insert_timeout(&conn->wdata);
     
    511521}
    512522
    513 /** Default fibril function that gets called to handle new connection.
    514  *
    515  * This function is defined as a weak symbol - to be redefined in user code.
    516  *
    517  * @param callid Hash of the incoming call.
    518  * @param call   Data of the incoming call.
    519  *
    520  */
    521 static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)
    522 {
    523         ipc_answer_0(callid, ENOENT);
    524 }
    525 
    526 /** Default fibril function that gets called to handle interrupt notifications.
    527  *
    528  * This function is defined as a weak symbol - to be redefined in user code.
    529  *
    530  * @param callid Hash of the incoming call.
    531  * @param call   Data of the incoming call.
    532  *
    533  */
    534 static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call)
    535 {
    536 }
    537 
    538523/** Wrapper for client connection fibril.
    539524 *
     
    548533static int connection_fibril(void *arg)
    549534{
    550         unsigned long key;
    551         client_t *cl;
    552         link_t *lnk;
    553         bool destroy = false;
    554 
    555535        /*
    556536         * Setup fibril-local connection pointer.
    557537         */
    558538        FIBRIL_connection = (connection_t *) arg;
    559 
     539       
     540        futex_down(&async_futex);
     541       
    560542        /*
    561543         * Add our reference for the current connection in the client task
     
    563545         * hash in a new tracking structure.
    564546         */
    565         futex_down(&async_futex);
    566         key = FIBRIL_connection->in_task_hash;
    567         lnk = hash_table_find(&client_hash_table, &key);
     547       
     548        unsigned long key = FIBRIL_connection->in_task_hash;
     549        link_t *lnk = hash_table_find(&client_hash_table, &key);
     550       
     551        client_t *client;
     552       
    568553        if (lnk) {
    569                 cl = hash_table_get_instance(lnk, client_t, link);
    570                 cl->refcnt++;
     554                client = hash_table_get_instance(lnk, client_t, link);
     555                client->refcnt++;
    571556        } else {
    572                 cl = malloc(sizeof(client_t));
    573                 if (!cl) {
     557                client = malloc(sizeof(client_t));
     558                if (!client) {
    574559                        ipc_answer_0(FIBRIL_connection->callid, ENOMEM);
    575560                        futex_up(&async_futex);
    576561                        return 0;
    577562                }
    578                 cl->in_task_hash = FIBRIL_connection->in_task_hash;
     563               
     564                client->in_task_hash = FIBRIL_connection->in_task_hash;
     565               
    579566                async_serialize_start();
    580                 cl->data = async_client_data_create();
     567                client->data = async_client_data_create();
    581568                async_serialize_end();
    582                 cl->refcnt = 1;
    583                 hash_table_insert(&client_hash_table, &key, &cl->link);
    584         }
     569               
     570                client->refcnt = 1;
     571                hash_table_insert(&client_hash_table, &key, &client->link);
     572        }
     573       
    585574        futex_up(&async_futex);
    586 
    587         FIBRIL_connection->client = cl;
    588 
     575       
     576        FIBRIL_connection->client = client;
     577       
    589578        /*
    590579         * Call the connection handler function.
     
    596585         * Remove the reference for this client task connection.
    597586         */
     587        bool destroy;
     588       
    598589        futex_down(&async_futex);
    599         if (--cl->refcnt == 0) {
     590       
     591        if (--client->refcnt == 0) {
    600592                hash_table_remove(&client_hash_table, &key, 1);
    601593                destroy = true;
    602         }
     594        } else
     595                destroy = false;
     596       
    603597        futex_up(&async_futex);
    604 
     598       
    605599        if (destroy) {
    606                 if (cl->data)
    607                         async_client_data_destroy(cl->data);
    608                 free(cl);
    609         }
    610 
     600                if (client->data)
     601                        async_client_data_destroy(client->data);
     602               
     603                free(client);
     604        }
     605       
    611606        /*
    612607         * Remove myself from the connection hash table.
     
    621616         */
    622617        while (!list_empty(&FIBRIL_connection->msg_queue)) {
    623                 msg_t *msg;
    624                
    625                 msg = list_get_instance(FIBRIL_connection->msg_queue.next,
    626                     msg_t, link);
     618                msg_t *msg =
     619                    list_get_instance(FIBRIL_connection->msg_queue.next, msg_t,
     620                    link);
     621               
    627622                list_remove(&msg->link);
    628623                ipc_answer_0(msg->callid, EHANGUP);
     
    637632                ipc_answer_0(FIBRIL_connection->close_callid, EOK);
    638633       
     634        free(FIBRIL_connection);
    639635        return 0;
    640636}
     
    667663                if (callid)
    668664                        ipc_answer_0(callid, ENOMEM);
     665               
    669666                return (uintptr_t) NULL;
    670667        }
     
    714711static void handle_call(ipc_callid_t callid, ipc_call_t *call)
    715712{
    716         /* Unrouted call - do some default behaviour */
     713        /* Unrouted call - take some default action */
    717714        if ((callid & IPC_CALLID_NOTIFICATION)) {
    718715                process_notification(callid, call);
    719                 goto out;
     716                return;
    720717        }
    721718       
     
    723720        case IPC_M_CONNECT_ME:
    724721        case IPC_M_CONNECT_ME_TO:
    725                 /* Open new connection with fibril etc. */
     722                /* Open new connection with fibril, etc. */
    726723                async_new_connection(call->in_task_hash, IPC_GET_ARG5(*call),
    727724                    callid, call, client_connection);
    728                 goto out;
     725                return;
    729726        }
    730727       
    731728        /* Try to route the call through the connection hash table */
    732729        if (route_call(callid, call))
    733                 goto out;
     730                return;
    734731       
    735732        /* Unknown call from unknown phone - hang it up */
    736733        ipc_answer_0(callid, EHANGUP);
    737         return;
    738        
    739 out:
    740         ;
    741734}
    742735
     
    751744        link_t *cur = timeout_list.next;
    752745        while (cur != &timeout_list) {
    753                 awaiter_t *waiter;
    754                
    755                 waiter = list_get_instance(cur, awaiter_t, to_event.link);
     746                awaiter_t *waiter =
     747                    list_get_instance(cur, awaiter_t, to_event.link);
     748               
    756749                if (tv_gt(&waiter->to_event.expires, &tv))
    757750                        break;
    758 
     751               
    759752                cur = cur->next;
    760 
     753               
    761754                list_remove(&waiter->to_event.link);
    762755                waiter->to_event.inlist = false;
     
    785778        while (true) {
    786779                if (fibril_switch(FIBRIL_FROM_MANAGER)) {
    787                         futex_up(&async_futex); 
     780                        futex_up(&async_futex);
    788781                        /*
    789782                         * async_futex is always held when entering a manager
     
    808801                                continue;
    809802                        } else
    810                                 timeout = tv_sub(&waiter->to_event.expires,
    811                                     &tv);
     803                                timeout = tv_sub(&waiter->to_event.expires, &tv);
    812804                } else
    813805                        timeout = SYNCH_NO_TIMEOUT;
    814806               
    815807                futex_up(&async_futex);
    816 
     808               
    817809                atomic_inc(&threads_in_ipc_wait);
    818810               
     
    822814               
    823815                atomic_dec(&threads_in_ipc_wait);
    824 
     816               
    825817                if (!callid) {
    826818                        handle_expired_timeouts();
     
    872864/** Initialize the async framework.
    873865 *
    874  * @return Zero on success or an error code.
    875  */
    876 int __async_init(void)
     866 */
     867void __async_init(void)
    877868{
    878869        if (!hash_table_create(&client_hash_table, CLIENT_HASH_TABLE_BUCKETS, 1,
    879             &client_hash_table_ops) || !hash_table_create(&conn_hash_table,
    880             CONN_HASH_TABLE_BUCKETS, 1, &conn_hash_table_ops)) {
    881                 return ENOMEM;
    882         }
    883 
    884         _async_sess_init();
    885        
    886         return 0;
     870            &client_hash_table_ops))
     871                abort();
     872       
     873        if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_BUCKETS, 1,
     874            &conn_hash_table_ops))
     875                abort();
    887876}
    888877
     
    897886 * @param retval Value returned in the answer.
    898887 * @param data   Call data of the answer.
     888 *
    899889 */
    900890static void reply_received(void *arg, int retval, ipc_call_t *data)
     
    944934    sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, ipc_call_t *dataptr)
    945935{
    946         amsg_t *msg = malloc(sizeof(*msg));
     936        amsg_t *msg = malloc(sizeof(amsg_t));
    947937       
    948938        if (!msg)
     
    953943       
    954944        msg->wdata.to_event.inlist = false;
    955         /* We may sleep in the next method, but it will use its own mechanism */
     945       
     946        /*
     947         * We may sleep in the next method,
     948         * but it will use its own means
     949         */
    956950        msg->wdata.active = true;
    957951       
     
    984978    ipc_call_t *dataptr)
    985979{
    986         amsg_t *msg = malloc(sizeof(*msg));
     980        amsg_t *msg = malloc(sizeof(amsg_t));
    987981       
    988982        if (!msg)
     
    993987       
    994988        msg->wdata.to_event.inlist = false;
    995         /* We may sleep in next method, but it will use its own mechanism */
     989       
     990        /*
     991         * We may sleep in the next method,
     992         * but it will use its own means
     993         */
    996994        msg->wdata.active = true;
    997995       
     
    10921090void async_usleep(suseconds_t timeout)
    10931091{
    1094         amsg_t *msg = malloc(sizeof(*msg));
     1092        amsg_t *msg = malloc(sizeof(amsg_t));
    10951093       
    10961094        if (!msg)
     
    12351233}
    12361234
     1235void async_msg_0(int phone, sysarg_t imethod)
     1236{
     1237        ipc_call_async_0(phone, imethod, NULL, NULL, true);
     1238}
     1239
     1240void async_msg_1(int phone, sysarg_t imethod, sysarg_t arg1)
     1241{
     1242        ipc_call_async_1(phone, imethod, arg1, NULL, NULL, true);
     1243}
     1244
     1245void async_msg_2(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2)
     1246{
     1247        ipc_call_async_2(phone, imethod, arg1, arg2, NULL, NULL, true);
     1248}
     1249
     1250void async_msg_3(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2,
     1251    sysarg_t arg3)
     1252{
     1253        ipc_call_async_3(phone, imethod, arg1, arg2, arg3, NULL, NULL, true);
     1254}
     1255
     1256void async_msg_4(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2,
     1257    sysarg_t arg3, sysarg_t arg4)
     1258{
     1259        ipc_call_async_4(phone, imethod, arg1, arg2, arg3, arg4, NULL, NULL,
     1260            true);
     1261}
     1262
     1263void async_msg_5(int phone, sysarg_t imethod, sysarg_t arg1, sysarg_t arg2,
     1264    sysarg_t arg3, sysarg_t arg4, sysarg_t arg5)
     1265{
     1266        ipc_call_async_5(phone, imethod, arg1, arg2, arg3, arg4, arg5, NULL,
     1267            NULL, true);
     1268}
     1269
     1270sysarg_t async_answer_0(ipc_callid_t callid, sysarg_t retval)
     1271{
     1272        return ipc_answer_0(callid, retval);
     1273}
     1274
     1275sysarg_t async_answer_1(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1)
     1276{
     1277        return ipc_answer_1(callid, retval, arg1);
     1278}
     1279
     1280sysarg_t async_answer_2(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1281    sysarg_t arg2)
     1282{
     1283        return ipc_answer_2(callid, retval, arg1, arg2);
     1284}
     1285
     1286sysarg_t async_answer_3(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1287    sysarg_t arg2, sysarg_t arg3)
     1288{
     1289        return ipc_answer_3(callid, retval, arg1, arg2, arg3);
     1290}
     1291
     1292sysarg_t async_answer_4(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1293    sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
     1294{
     1295        return ipc_answer_4(callid, retval, arg1, arg2, arg3, arg4);
     1296}
     1297
     1298sysarg_t async_answer_5(ipc_callid_t callid, sysarg_t retval, sysarg_t arg1,
     1299    sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5)
     1300{
     1301        return ipc_answer_5(callid, retval, arg1, arg2, arg3, arg4, arg5);
     1302}
     1303
     1304int async_forward_fast(ipc_callid_t callid, int phoneid, sysarg_t imethod,
     1305    sysarg_t arg1, sysarg_t arg2, unsigned int mode)
     1306{
     1307        return ipc_forward_fast(callid, phoneid, imethod, arg1, arg2, mode);
     1308}
     1309
     1310int async_forward_slow(ipc_callid_t callid, int phoneid, sysarg_t imethod,
     1311    sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5,
     1312    unsigned int mode)
     1313{
     1314        return ipc_forward_slow(callid, phoneid, imethod, arg1, arg2, arg3, arg4,
     1315            arg5, mode);
     1316}
     1317
     1318/** Wrapper for making IPC_M_CONNECT_TO_ME calls using the async framework.
     1319 *
     1320 * Ask through phone for a new connection to some service.
     1321 *
     1322 * @param phone           Phone handle used for contacting the other side.
     1323 * @param arg1            User defined argument.
     1324 * @param arg2            User defined argument.
     1325 * @param arg3            User defined argument.
     1326 * @param client_receiver Connection handing routine.
     1327 *
     1328 * @return New phone handle on success or a negative error code.
     1329 *
     1330 */
     1331int async_connect_to_me(int phone, sysarg_t arg1, sysarg_t arg2,
     1332    sysarg_t arg3, async_client_conn_t client_receiver)
     1333{
     1334        sysarg_t task_hash;
     1335        sysarg_t phone_hash;
     1336        int rc = async_req_3_5(phone, IPC_M_CONNECT_TO_ME, arg1, arg2, arg3,
     1337            NULL, NULL, NULL, &task_hash, &phone_hash);
     1338        if (rc != EOK)
     1339                return rc;
     1340       
     1341        if (client_receiver != NULL)
     1342                async_new_connection(task_hash, phone_hash, 0, NULL,
     1343                    client_receiver);
     1344       
     1345        return EOK;
     1346}
     1347
    12371348/** Wrapper for making IPC_M_CONNECT_ME_TO calls using the async framework.
    1238  * 
     1349 *
    12391350 * Ask through phone for a new connection to some service.
    12401351 *
    1241  * @param phoneid       Phone handle used for contacting the other side.
    1242  * @param arg1          User defined argument.
    1243  * @param arg2          User defined argument.
    1244  * @param arg3          User defined argument.
    1245  *
    1246  * @return              New phone handle on success or a negative error code.
    1247  */
    1248 int
    1249 async_connect_me_to(int phoneid, sysarg_t arg1, sysarg_t arg2, sysarg_t arg3)
    1250 {
    1251         int rc;
     1352 * @param phone Phone handle used for contacting the other side.
     1353 * @param arg1  User defined argument.
     1354 * @param arg2  User defined argument.
     1355 * @param arg3  User defined argument.
     1356 *
     1357 * @return New phone handle on success or a negative error code.
     1358 *
     1359 */
     1360int async_connect_me_to(int phone, sysarg_t arg1, sysarg_t arg2,
     1361    sysarg_t arg3)
     1362{
    12521363        sysarg_t newphid;
    1253 
    1254         rc = async_req_3_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3, NULL,
    1255             NULL, NULL, NULL, &newphid);
    1256        
    1257         if (rc != EOK) 
     1364        int rc = async_req_3_5(phone, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3,
     1365            NULL, NULL, NULL, NULL, &newphid);
     1366       
     1367        if (rc != EOK)
    12581368                return rc;
    1259 
     1369       
    12601370        return newphid;
    12611371}
    12621372
    12631373/** Wrapper for making IPC_M_CONNECT_ME_TO calls using the async framework.
    1264  * 
     1374 *
    12651375 * Ask through phone for a new connection to some service and block until
    12661376 * success.
    12671377 *
    1268  * @param phoneid       Phone handle used for contacting the other side.
    1269  * @param arg1          User defined argument.
    1270  * @param arg2          User defined argument.
    1271  * @param arg3          User defined argument.
    1272  *
    1273  * @return              New phone handle on success or a negative error code.
    1274  */
    1275 int
    1276 async_connect_me_to_blocking(int phoneid, sysarg_t arg1, sysarg_t arg2,
     1378 * @param phoneid Phone handle used for contacting the other side.
     1379 * @param arg1    User defined argument.
     1380 * @param arg2    User defined argument.
     1381 * @param arg3    User defined argument.
     1382 *
     1383 * @return New phone handle on success or a negative error code.
     1384 *
     1385 */
     1386int async_connect_me_to_blocking(int phoneid, sysarg_t arg1, sysarg_t arg2,
    12771387    sysarg_t arg3)
    12781388{
    1279         int rc;
    12801389        sysarg_t newphid;
    1281 
    1282         rc = async_req_4_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3,
     1390        int rc = async_req_4_5(phoneid, IPC_M_CONNECT_ME_TO, arg1, arg2, arg3,
    12831391            IPC_FLAG_BLOCKING, NULL, NULL, NULL, NULL, &newphid);
    12841392       
    1285         if (rc != EOK) 
     1393        if (rc != EOK)
    12861394                return rc;
    1287 
     1395       
    12881396        return newphid;
    12891397}
    12901398
    1291 /** Wrapper for making IPC_M_SHARE_IN calls using the async framework.
    1292  *
    1293  * @param phoneid       Phone that will be used to contact the receiving side.
    1294  * @param dst           Destination address space area base.
    1295  * @param size          Size of the destination address space area.
    1296  * @param arg           User defined argument.
    1297  * @param flags         Storage where the received flags will be stored. Can be
    1298  *                      NULL.
    1299  *
    1300  * @return              Zero on success or a negative error code from errno.h.
     1399/** Connect to a task specified by id.
     1400 *
     1401 */
     1402int async_connect_kbox(task_id_t id)
     1403{
     1404        return ipc_connect_kbox(id);
     1405}
     1406
     1407/** Wrapper for ipc_hangup.
     1408 *
     1409 * @param phone Phone handle to hung up.
     1410 *
     1411 * @return Zero on success or a negative error code.
     1412 *
     1413 */
     1414int async_hangup(int phone)
     1415{
     1416        return ipc_hangup(phone);
     1417}
     1418
     1419/** Interrupt one thread of this task from waiting for IPC. */
     1420void async_poke(void)
     1421{
     1422        ipc_poke();
     1423}
     1424
     1425/** Wrapper for IPC_M_SHARE_IN calls using the async framework.
     1426 *
     1427 * @param phoneid Phone that will be used to contact the receiving side.
     1428 * @param dst     Destination address space area base.
     1429 * @param size    Size of the destination address space area.
     1430 * @param arg     User defined argument.
     1431 * @param flags   Storage for the received flags. Can be NULL.
     1432 *
     1433 * @return Zero on success or a negative error code from errno.h.
     1434 *
    13011435 */
    13021436int async_share_in_start(int phoneid, void *dst, size_t size, sysarg_t arg,
    1303     int *flags)
    1304 {
    1305         int res;
     1437    unsigned int *flags)
     1438{
    13061439        sysarg_t tmp_flags;
    1307         res = async_req_3_2(phoneid, IPC_M_SHARE_IN, (sysarg_t) dst,
     1440        int res = async_req_3_2(phoneid, IPC_M_SHARE_IN, (sysarg_t) dst,
    13081441            (sysarg_t) size, arg, NULL, &tmp_flags);
     1442       
    13091443        if (flags)
    1310                 *flags = tmp_flags;
     1444                *flags = (unsigned int) tmp_flags;
     1445       
    13111446        return res;
    13121447}
     
    13141449/** Wrapper for receiving the IPC_M_SHARE_IN calls using the async framework.
    13151450 *
    1316  * This wrapper only makes it more comfortable to receive IPC_M_SHARE_IN calls
    1317  * so that the user doesn't have to remember the meaning of each IPC argument.
     1451 * This wrapper only makes it more comfortable to receive IPC_M_SHARE_IN
     1452 * calls so that the user doesn't have to remember the meaning of each IPC
     1453 * argument.
    13181454 *
    13191455 * So far, this wrapper is to be used from within a connection fibril.
    13201456 *
    1321  * @param callid        Storage where the hash of the IPC_M_SHARE_IN call will
    1322  *                      be stored.
    1323  * @param size          Destination address space area size.   
    1324  *
    1325  * @return              Non-zero on success, zero on failure.
    1326  */
    1327 int async_share_in_receive(ipc_callid_t *callid, size_t *size)
    1328 {
    1329         ipc_call_t data;
    1330        
     1457 * @param callid Storage for the hash of the IPC_M_SHARE_IN call.
     1458 * @param size   Destination address space area size.
     1459 *
     1460 * @return True on success, false on failure.
     1461 *
     1462 */
     1463bool async_share_in_receive(ipc_callid_t *callid, size_t *size)
     1464{
    13311465        assert(callid);
    13321466        assert(size);
    1333 
     1467       
     1468        ipc_call_t data;
    13341469        *callid = async_get_call(&data);
     1470       
    13351471        if (IPC_GET_IMETHOD(data) != IPC_M_SHARE_IN)
    1336                 return 0;
     1472                return false;
     1473       
    13371474        *size = (size_t) IPC_GET_ARG2(data);
    1338         return 1;
     1475        return true;
    13391476}
    13401477
    13411478/** Wrapper for answering the IPC_M_SHARE_IN calls using the async framework.
    13421479 *
    1343  * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ calls
    1344  * so that the user doesn't have to remember the meaning of each IPC argument.
    1345  *
    1346  * @param callid        Hash of the IPC_M_DATA_READ call to answer.
    1347  * @param src           Source address space base.
    1348  * @param flags         Flags to be used for sharing. Bits can be only cleared.
    1349  *
    1350  * @return              Zero on success or a value from @ref errno.h on failure.
    1351  */
    1352 int async_share_in_finalize(ipc_callid_t callid, void *src, int flags)
     1480 * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ
     1481 * calls so that the user doesn't have to remember the meaning of each IPC
     1482 * argument.
     1483 *
     1484 * @param callid Hash of the IPC_M_DATA_READ call to answer.
     1485 * @param src    Source address space base.
     1486 * @param flags  Flags to be used for sharing. Bits can be only cleared.
     1487 *
     1488 * @return Zero on success or a value from @ref errno.h on failure.
     1489 *
     1490 */
     1491int async_share_in_finalize(ipc_callid_t callid, void *src, unsigned int flags)
    13531492{
    13541493        return ipc_share_in_finalize(callid, src, flags);
    13551494}
    13561495
    1357 /** Wrapper for making IPC_M_SHARE_OUT calls using the async framework.
    1358  *
    1359  * @param phoneid       Phone that will be used to contact the receiving side.
    1360  * @param src           Source address space area base address.
    1361  * @param flags         Flags to be used for sharing. Bits can be only cleared.
    1362  *
    1363  * @return              Zero on success or a negative error code from errno.h.
    1364  */
    1365 int async_share_out_start(int phoneid, void *src, int flags)
     1496/** Wrapper for IPC_M_SHARE_OUT calls using the async framework.
     1497 *
     1498 * @param phoneid Phone that will be used to contact the receiving side.
     1499 * @param src     Source address space area base address.
     1500 * @param flags   Flags to be used for sharing. Bits can be only cleared.
     1501 *
     1502 * @return Zero on success or a negative error code from errno.h.
     1503 *
     1504 */
     1505int async_share_out_start(int phoneid, void *src, unsigned int flags)
    13661506{
    13671507        return async_req_3_0(phoneid, IPC_M_SHARE_OUT, (sysarg_t) src, 0,
     
    13711511/** Wrapper for receiving the IPC_M_SHARE_OUT calls using the async framework.
    13721512 *
    1373  * This wrapper only makes it more comfortable to receive IPC_M_SHARE_OUT calls
    1374  * so that the user doesn't have to remember the meaning of each IPC argument.
     1513 * This wrapper only makes it more comfortable to receive IPC_M_SHARE_OUT
     1514 * calls so that the user doesn't have to remember the meaning of each IPC
     1515 * argument.
    13751516 *
    13761517 * So far, this wrapper is to be used from within a connection fibril.
    13771518 *
    1378  * @param callid        Storage where the hash of the IPC_M_SHARE_OUT call will
    1379  *                      be stored.
    1380  * @param size          Storage where the source address space area size will be
    1381  *                      stored.
    1382  * @param flags         Storage where the sharing flags will be stored.
    1383  *
    1384  * @return              Non-zero on success, zero on failure.
    1385  */
    1386 int async_share_out_receive(ipc_callid_t *callid, size_t *size, int *flags)
    1387 {
    1388         ipc_call_t data;
    1389        
     1519 * @param callid Storage for the hash of the IPC_M_SHARE_OUT call.
     1520 * @param size   Storage for the source address space area size.
     1521 * @param flags  Storage for the sharing flags.
     1522 *
     1523 * @return True on success, false on failure.
     1524 *
     1525 */
     1526bool async_share_out_receive(ipc_callid_t *callid, size_t *size, unsigned int *flags)
     1527{
    13901528        assert(callid);
    13911529        assert(size);
    13921530        assert(flags);
    1393 
     1531       
     1532        ipc_call_t data;
    13941533        *callid = async_get_call(&data);
     1534       
    13951535        if (IPC_GET_IMETHOD(data) != IPC_M_SHARE_OUT)
    1396                 return 0;
     1536                return false;
     1537       
    13971538        *size = (size_t) IPC_GET_ARG2(data);
    1398         *flags = (int) IPC_GET_ARG3(data);
    1399         return 1;
     1539        *flags = (unsigned int) IPC_GET_ARG3(data);
     1540        return true;
    14001541}
    14011542
    14021543/** Wrapper for answering the IPC_M_SHARE_OUT calls using the async framework.
    14031544 *
    1404  * This wrapper only makes it more comfortable to answer IPC_M_SHARE_OUT calls
    1405  * so that the user doesn't have to remember the meaning of each IPC argument.
    1406  *
    1407  * @param callid        Hash of the IPC_M_DATA_WRITE call to answer.
    1408  * @param dst           Destination address space area base address.   
    1409  *
    1410  * @return              Zero on success or a value from @ref errno.h on failure.
     1545 * This wrapper only makes it more comfortable to answer IPC_M_SHARE_OUT
     1546 * calls so that the user doesn't have to remember the meaning of each IPC
     1547 * argument.
     1548 *
     1549 * @param callid Hash of the IPC_M_DATA_WRITE call to answer.
     1550 * @param dst    Destination address space area base address.
     1551 *
     1552 * @return Zero on success or a value from @ref errno.h on failure.
     1553 *
    14111554 */
    14121555int async_share_out_finalize(ipc_callid_t callid, void *dst)
     
    14151558}
    14161559
    1417 
    1418 /** Wrapper for making IPC_M_DATA_READ calls using the async framework.
    1419  *
    1420  * @param phoneid       Phone that will be used to contact the receiving side.
    1421  * @param dst           Address of the beginning of the destination buffer.
    1422  * @param size          Size of the destination buffer.
    1423  *
    1424  * @return              Zero on success or a negative error code from errno.h.
     1560/** Wrapper for IPC_M_DATA_READ calls using the async framework.
     1561 *
     1562 * @param phoneid Phone that will be used to contact the receiving side.
     1563 * @param dst     Address of the beginning of the destination buffer.
     1564 * @param size    Size of the destination buffer.
     1565 *
     1566 * @return Zero on success or a negative error code from errno.h.
     1567 *
    14251568 */
    14261569int async_data_read_start(int phoneid, void *dst, size_t size)
     
    14321575/** Wrapper for receiving the IPC_M_DATA_READ calls using the async framework.
    14331576 *
    1434  * This wrapper only makes it more comfortable to receive IPC_M_DATA_READ calls
    1435  * so that the user doesn't have to remember the meaning of each IPC argument.
     1577 * This wrapper only makes it more comfortable to receive IPC_M_DATA_READ
     1578 * calls so that the user doesn't have to remember the meaning of each IPC
     1579 * argument.
    14361580 *
    14371581 * So far, this wrapper is to be used from within a connection fibril.
    14381582 *
    1439  * @param callid        Storage where the hash of the IPC_M_DATA_READ call will
    1440  *                      be stored.
    1441  * @param size          Storage where the maximum size will be stored. Can be
    1442  *                      NULL.
    1443  *
    1444  * @return              Non-zero on success, zero on failure.
    1445  */
    1446 int async_data_read_receive(ipc_callid_t *callid, size_t *size)
    1447 {
     1583 * @param callid Storage for the hash of the IPC_M_DATA_READ.
     1584 * @param size   Storage for the maximum size. Can be NULL.
     1585 *
     1586 * @return True on success, false on failure.
     1587 *
     1588 */
     1589bool async_data_read_receive(ipc_callid_t *callid, size_t *size)
     1590{
     1591        assert(callid);
     1592       
    14481593        ipc_call_t data;
    1449        
    1450         assert(callid);
    1451 
    14521594        *callid = async_get_call(&data);
     1595       
    14531596        if (IPC_GET_IMETHOD(data) != IPC_M_DATA_READ)
    1454                 return 0;
     1597                return false;
     1598       
    14551599        if (size)
    14561600                *size = (size_t) IPC_GET_ARG2(data);
    1457         return 1;
     1601       
     1602        return true;
    14581603}
    14591604
    14601605/** Wrapper for answering the IPC_M_DATA_READ calls using the async framework.
    14611606 *
    1462  * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ calls
    1463  * so that the user doesn't have to remember the meaning of each IPC argument.
    1464  *
    1465  * @param callid        Hash of the IPC_M_DATA_READ call to answer.
    1466  * @param src           Source address for the IPC_M_DATA_READ call.
    1467  * @param size          Size for the IPC_M_DATA_READ call. Can be smaller than
    1468  *                      the maximum size announced by the sender.
    1469  *
    1470  * @return              Zero on success or a value from @ref errno.h on failure.
     1607 * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ
     1608 * calls so that the user doesn't have to remember the meaning of each IPC
     1609 * argument.
     1610 *
     1611 * @param callid Hash of the IPC_M_DATA_READ call to answer.
     1612 * @param src    Source address for the IPC_M_DATA_READ call.
     1613 * @param size   Size for the IPC_M_DATA_READ call. Can be smaller than
     1614 *               the maximum size announced by the sender.
     1615 *
     1616 * @return Zero on success or a value from @ref errno.h on failure.
     1617 *
    14711618 */
    14721619int async_data_read_finalize(ipc_callid_t callid, const void *src, size_t size)
     
    14761623
    14771624/** Wrapper for forwarding any read request
    1478  *
    14791625 *
    14801626 */
     
    15091655}
    15101656
    1511 /** Wrapper for making IPC_M_DATA_WRITE calls using the async framework.
     1657/** Wrapper for IPC_M_DATA_WRITE calls using the async framework.
    15121658 *
    15131659 * @param phoneid Phone that will be used to contact the receiving side.
     
    15261672/** Wrapper for receiving the IPC_M_DATA_WRITE calls using the async framework.
    15271673 *
    1528  * This wrapper only makes it more comfortable to receive IPC_M_DATA_WRITE calls
    1529  * so that the user doesn't have to remember the meaning of each IPC argument.
     1674 * This wrapper only makes it more comfortable to receive IPC_M_DATA_WRITE
     1675 * calls so that the user doesn't have to remember the meaning of each IPC
     1676 * argument.
    15301677 *
    15311678 * So far, this wrapper is to be used from within a connection fibril.
    15321679 *
    1533  * @param callid Storage where the hash of the IPC_M_DATA_WRITE call will
    1534  *               be stored.
    1535  * @param size   Storage where the suggested size will be stored. May be
    1536  *               NULL
    1537  *
    1538  * @return Non-zero on success, zero on failure.
    1539  *
    1540  */
    1541 int async_data_write_receive(ipc_callid_t *callid, size_t *size)
    1542 {
     1680 * @param callid Storage for the hash of the IPC_M_DATA_WRITE.
     1681 * @param size   Storage for the suggested size. May be NULL.
     1682 *
     1683 * @return True on success, false on failure.
     1684 *
     1685 */
     1686bool async_data_write_receive(ipc_callid_t *callid, size_t *size)
     1687{
     1688        assert(callid);
     1689       
    15431690        ipc_call_t data;
    1544        
    1545         assert(callid);
    1546        
    15471691        *callid = async_get_call(&data);
     1692       
    15481693        if (IPC_GET_IMETHOD(data) != IPC_M_DATA_WRITE)
    1549                 return 0;
     1694                return false;
    15501695       
    15511696        if (size)
    15521697                *size = (size_t) IPC_GET_ARG2(data);
    15531698       
    1554         return 1;
     1699        return true;
    15551700}
    15561701
    15571702/** Wrapper for answering the IPC_M_DATA_WRITE calls using the async framework.
    15581703 *
    1559  * This wrapper only makes it more comfortable to answer IPC_M_DATA_WRITE calls
    1560  * so that the user doesn't have to remember the meaning of each IPC argument.
     1704 * This wrapper only makes it more comfortable to answer IPC_M_DATA_WRITE
     1705 * calls so that the user doesn't have to remember the meaning of each IPC
     1706 * argument.
    15611707 *
    15621708 * @param callid Hash of the IPC_M_DATA_WRITE call to answer.
     
    16541800 *
    16551801 */
    1656 void async_data_write_void(const int retval)
     1802void async_data_write_void(sysarg_t retval)
    16571803{
    16581804        ipc_callid_t callid;
     
    16621808
    16631809/** Wrapper for forwarding any data that is about to be received
    1664  *
    16651810 *
    16661811 */
Note: See TracChangeset for help on using the changeset viewer.