Subversion Repositories HelenOS

Rev

Rev 4153 | Rev 4581 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1351 palkovsky 1
/*
2071 jermar 2
 * Copyright (c) 2006 Ondrej Palkovsky
1351 palkovsky 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1653 cejka 27
 */
28
 
1719 decky 29
/** @addtogroup libc
1653 cejka 30
 * @{
31
 */
32
/** @file
4327 mejdrech 33
 */
1351 palkovsky 34
 
1392 palkovsky 35
/**
36
 * Asynchronous library
37
 *
4327 mejdrech 38
 * The aim of this library is to provide a facility for writing programs which
39
 * utilize the asynchronous nature of HelenOS IPC, yet using a normal way of
40
 * programming.
1392 palkovsky 41
 *
2484 jermar 42
 * You should be able to write very simple multithreaded programs, the async
43
 * framework will automatically take care of most synchronization problems.
1392 palkovsky 44
 *
45
 * Default semantics:
4327 mejdrech 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 ]
1392 palkovsky 49
 *
2484 jermar 50
 * Example of use (pseudo C):
4327 mejdrech 51
 *
1392 palkovsky 52
 * 1) Multithreaded client application
2484 jermar 53
 *
4327 mejdrech 54
 *   fibril_create(fibril1, ...);
55
 *   fibril_create(fibril2, ...);
56
 *   ...
1392 palkovsky 57
 *
4327 mejdrech 58
 *   int fibril1(void *arg)
59
 *   {
60
 *     conn = ipc_connect_me_to();
61
 *     c1 = async_send(conn);
62
 *     c2 = async_send(conn);
63
 *     async_wait_for(c1);
64
 *     async_wait_for(c2);
65
 *     ...
66
 *   }
1392 palkovsky 67
 *
4327 mejdrech 68
 *
1392 palkovsky 69
 * 2) Multithreaded server application
70
 *
4327 mejdrech 71
 *   main()
72
 *   {
73
 *     async_manager();
74
 *   }
1392 palkovsky 75
 *
4327 mejdrech 76
 *   my_client_connection(icallid, *icall)
77
 *   {
78
 *     if (want_refuse) {
79
 *       ipc_answer_0(icallid, ELIMIT);
80
 *       return;
81
 *     }
82
 *     ipc_answer_0(icallid, EOK);
1407 palkovsky 83
 *
4327 mejdrech 84
 *     callid = async_get_call(&call);
85
 *     handle_call(callid, call);
86
 *     ipc_answer_2(callid, 1, 2, 3);
1404 palkovsky 87
 *
4327 mejdrech 88
 *     callid = async_get_call(&call);
89
 *     ...
90
 *   }
91
 *
1392 palkovsky 92
 */
2484 jermar 93
 
1392 palkovsky 94
#include <futex.h>
95
#include <async.h>
2482 jermar 96
#include <fibril.h>
1392 palkovsky 97
#include <stdio.h>
98
#include <libadt/hash_table.h>
99
#include <libadt/list.h>
100
#include <ipc/ipc.h>
101
#include <assert.h>
102
#include <errno.h>
2486 jermar 103
#include <sys/time.h>
1441 palkovsky 104
#include <arch/barrier.h>
2621 jermar 105
#include <bool.h>
1392 palkovsky 106
 
1463 palkovsky 107
atomic_t async_futex = FUTEX_INITIALIZER;
1392 palkovsky 108
 
2488 jermar 109
/** Structures of this type represent a waiting fibril. */
1392 palkovsky 110
typedef struct {
2488 jermar 111
    /** Expiration time. */
4327 mejdrech 112
    struct timeval expires;
113
 
2482 jermar 114
    /** If true, this struct is in the timeout list. */
4327 mejdrech 115
    bool inlist;
116
 
2488 jermar 117
    /** Timeout list link. */
1500 palkovsky 118
    link_t link;
4327 mejdrech 119
 
2490 jermar 120
    /** Identification of and link to the waiting fibril. */
2482 jermar 121
    fid_t fid;
4327 mejdrech 122
 
2488 jermar 123
    /** If true, this fibril is currently active. */
4327 mejdrech 124
    bool active;
125
 
2488 jermar 126
    /** If true, we have timed out. */
4327 mejdrech 127
    bool timedout;
1500 palkovsky 128
} awaiter_t;
129
 
130
typedef struct {
131
    awaiter_t wdata;
2488 jermar 132
 
133
    /** If reply was received. */
4327 mejdrech 134
    bool done;
135
 
2488 jermar 136
    /** Pointer to where the answer data is stored. */
4327 mejdrech 137
    ipc_call_t *dataptr;
138
 
1427 palkovsky 139
    ipcarg_t retval;
140
} amsg_t;
141
 
2490 jermar 142
/**
143
 * Structures of this type are used to group information about a call and a
144
 * message queue link.
145
 */
1427 palkovsky 146
typedef struct {
1392 palkovsky 147
    link_t link;
148
    ipc_callid_t callid;
149
    ipc_call_t call;
150
} msg_t;
151
 
152
typedef struct {
1500 palkovsky 153
    awaiter_t wdata;
4327 mejdrech 154
 
2488 jermar 155
    /** Hash table link. */
156
    link_t link;
4327 mejdrech 157
 
2488 jermar 158
    /** Incoming phone hash. */
4327 mejdrech 159
    ipcarg_t in_phone_hash;
160
 
2488 jermar 161
    /** Messages that should be delivered to this fibril. */
4327 mejdrech 162
    link_t msg_queue;
163
 
2488 jermar 164
    /** Identification of the opening call. */
1392 palkovsky 165
    ipc_callid_t callid;
2488 jermar 166
    /** Call data of the opening call. */
1392 palkovsky 167
    ipc_call_t call;
4327 mejdrech 168
 
2488 jermar 169
    /** Identification of the closing call. */
170
    ipc_callid_t close_callid;
4327 mejdrech 171
 
2488 jermar 172
    /** Fibril function that will be used to handle the connection. */
2482 jermar 173
    void (*cfibril)(ipc_callid_t, ipc_call_t *);
1392 palkovsky 174
} connection_t;
175
 
2482 jermar 176
/** Identifier of the incoming connection handled by the current fibril. */
177
__thread connection_t *FIBRIL_connection;
2488 jermar 178
 
1490 palkovsky 179
static void default_client_connection(ipc_callid_t callid, ipc_call_t *call);
1596 palkovsky 180
static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call);
2490 jermar 181
 
182
/**
183
 * Pointer to a fibril function that will be used to handle connections.
184
 */
1490 palkovsky 185
static async_client_conn_t client_connection = default_client_connection;
4327 mejdrech 186
 
2490 jermar 187
/**
188
 * Pointer to a fibril function that will be used to handle interrupt
189
 * notifications.
190
 */
1596 palkovsky 191
static async_client_conn_t interrupt_received = default_interrupt_received;
1490 palkovsky 192
 
2621 jermar 193
 
4327 mejdrech 194
static hash_table_t conn_hash_table;
195
static LIST_INITIALIZE(timeout_list);
1392 palkovsky 196
 
4327 mejdrech 197
 
198
#define CONN_HASH_TABLE_CHAINS  32
199
 
2488 jermar 200
/** Compute hash into the connection hash table based on the source phone hash.
201
 *
4327 mejdrech 202
 * @param key Pointer to source phone hash.
2488 jermar 203
 *
4327 mejdrech 204
 * @return Index into the connection hash table.
205
 *
2488 jermar 206
 */
1392 palkovsky 207
static hash_index_t conn_hash(unsigned long *key)
1351 palkovsky 208
{
1392 palkovsky 209
    assert(key);
4327 mejdrech 210
    return (((*key) >> 4) % CONN_HASH_TABLE_CHAINS);
1351 palkovsky 211
}
212
 
2488 jermar 213
/** Compare hash table item with a key.
214
 *
4327 mejdrech 215
 * @param key  Array containing the source phone hash as the only item.
216
 * @param keys Expected 1 but ignored.
217
 * @param item Connection hash table item.
2488 jermar 218
 *
4327 mejdrech 219
 * @return True on match, false otherwise.
220
 *
2488 jermar 221
 */
1392 palkovsky 222
static int conn_compare(unsigned long key[], hash_count_t keys, link_t *item)
1351 palkovsky 223
{
4327 mejdrech 224
    connection_t *hs = hash_table_get_instance(item, connection_t, link);
225
    return (key[0] == hs->in_phone_hash);
1351 palkovsky 226
}
227
 
2488 jermar 228
/** Connection hash table removal callback function.
229
 *
230
 * This function is called whenever a connection is removed from the connection
231
 * hash table.
232
 *
4327 mejdrech 233
 * @param item Connection hash table item being removed.
234
 *
2488 jermar 235
 */
1392 palkovsky 236
static void conn_remove(link_t *item)
1351 palkovsky 237
{
1392 palkovsky 238
    free(hash_table_get_instance(item, connection_t, link));
1351 palkovsky 239
}
240
 
1392 palkovsky 241
 
2488 jermar 242
/** Operations for the connection hash table. */
1392 palkovsky 243
static hash_table_operations_t conn_hash_table_ops = {
244
    .hash = conn_hash,
245
    .compare = conn_compare,
246
    .remove_callback = conn_remove
247
};
248
 
2488 jermar 249
/** Sort in current fibril's timeout request.
1500 palkovsky 250
 *
4327 mejdrech 251
 * @param wd Wait data of the current fibril.
252
 *
1500 palkovsky 253
 */
254
static void insert_timeout(awaiter_t *wd)
255
{
4327 mejdrech 256
    wd->timedout = false;
257
    wd->inlist = true;
258
 
259
    link_t *tmp = timeout_list.next;
1500 palkovsky 260
    while (tmp != &timeout_list) {
4327 mejdrech 261
        awaiter_t *cur = list_get_instance(tmp, awaiter_t, link);
262
 
1500 palkovsky 263
        if (tv_gteq(&cur->expires, &wd->expires))
264
            break;
4327 mejdrech 265
 
1500 palkovsky 266
        tmp = tmp->next;
267
    }
4327 mejdrech 268
 
1500 palkovsky 269
    list_append(&wd->link, tmp);
270
}
271
 
2488 jermar 272
/** Try to route a call to an appropriate connection fibril.
1392 palkovsky 273
 *
2490 jermar 274
 * If the proper connection fibril is found, a message with the call is added to
275
 * its message queue. If the fibril was not active, it is activated and all
276
 * timeouts are unregistered.
277
 *
4327 mejdrech 278
 * @param callid Hash of the incoming call.
279
 * @param call   Data of the incoming call.
2490 jermar 280
 *
4327 mejdrech 281
 * @return False if the call doesn't match any connection.
282
 *         True if the call was passed to the respective connection fibril.
283
 *
1392 palkovsky 284
 */
4327 mejdrech 285
static bool route_call(ipc_callid_t callid, ipc_call_t *call)
1351 palkovsky 286
{
1427 palkovsky 287
    futex_down(&async_futex);
4327 mejdrech 288
 
289
    unsigned long key = call->in_phone_hash;
290
    link_t *hlp = hash_table_find(&conn_hash_table, &key);
291
 
1392 palkovsky 292
    if (!hlp) {
1427 palkovsky 293
        futex_up(&async_futex);
4327 mejdrech 294
        return false;
1351 palkovsky 295
    }
4327 mejdrech 296
 
297
    connection_t *conn = hash_table_get_instance(hlp, connection_t, link);
298
 
299
    msg_t *msg = malloc(sizeof(*msg));
300
    if (!msg) {
301
        futex_up(&async_futex);
302
        return false;
303
    }
304
 
1392 palkovsky 305
    msg->callid = callid;
306
    msg->call = *call;
307
    list_append(&msg->link, &conn->msg_queue);
4327 mejdrech 308
 
1648 palkovsky 309
    if (IPC_GET_METHOD(*call) == IPC_M_PHONE_HUNGUP)
310
        conn->close_callid = callid;
1392 palkovsky 311
 
2490 jermar 312
    /* If the connection fibril is waiting for an event, activate it */
1500 palkovsky 313
    if (!conn->wdata.active) {
4327 mejdrech 314
 
1500 palkovsky 315
        /* If in timeout list, remove it */
316
        if (conn->wdata.inlist) {
4327 mejdrech 317
            conn->wdata.inlist = false;
1500 palkovsky 318
            list_remove(&conn->wdata.link);
319
        }
4327 mejdrech 320
 
321
        conn->wdata.active = true;
2482 jermar 322
        fibril_add_ready(conn->wdata.fid);
1392 palkovsky 323
    }
4327 mejdrech 324
 
1427 palkovsky 325
    futex_up(&async_futex);
4327 mejdrech 326
    return true;
327
}
1392 palkovsky 328
 
4327 mejdrech 329
/** Notification fibril.
330
 *
331
 * When a notification arrives, a fibril with this implementing function is
332
 * created. It calls interrupt_received() and does the final cleanup.
333
 *
334
 * @param arg Message structure pointer.
335
 *
336
 * @return Always zero.
337
 *
338
 */
339
static int notification_fibril(void *arg)
340
{
341
    msg_t *msg = (msg_t *) arg;
342
    interrupt_received(msg->callid, &msg->call);
343
 
344
    free(msg);
345
    return 0;
1392 palkovsky 346
}
347
 
4327 mejdrech 348
/** Process interrupt notification.
349
 *
350
 * A new fibril is created which would process the notification.
351
 *
352
 * @param callid Hash of the incoming call.
353
 * @param call   Data of the incoming call.
354
 *
355
 * @return False if an error occured.
356
 *         True if the call was passed to the notification fibril.
357
 *
358
 */
359
static bool process_notification(ipc_callid_t callid, ipc_call_t *call)
360
{
361
    futex_down(&async_futex);
362
 
363
    msg_t *msg = malloc(sizeof(*msg));
364
    if (!msg) {
365
        futex_up(&async_futex);
366
        return false;
367
    }
368
 
369
    msg->callid = callid;
370
    msg->call = *call;
371
 
372
    fid_t fid = fibril_create(notification_fibril, msg);
373
    fibril_add_ready(fid);
374
 
375
    futex_up(&async_futex);
376
    return true;
377
}
378
 
2488 jermar 379
/** Return new incoming message for the current (fibril-local) connection.
380
 *
4327 mejdrech 381
 * @param call  Storage where the incoming call data will be stored.
382
 * @param usecs Timeout in microseconds. Zero denotes no timeout.
2488 jermar 383
 *
4327 mejdrech 384
 * @return If no timeout was specified, then a hash of the
385
 *         incoming call is returned. If a timeout is specified,
386
 *         then a hash of the incoming call is returned unless
387
 *         the timeout expires prior to receiving a message. In
388
 *         that case zero is returned.
389
 *
2488 jermar 390
 */
1500 palkovsky 391
ipc_callid_t async_get_call_timeout(ipc_call_t *call, suseconds_t usecs)
1392 palkovsky 392
{
4327 mejdrech 393
    assert(FIBRIL_connection);
1392 palkovsky 394
 
4327 mejdrech 395
    /* Why doing this?
396
     * GCC 4.1.0 coughs on FIBRIL_connection-> dereference.
1536 palkovsky 397
     * GCC 4.1.1 happilly puts the rdhwr instruction in delay slot.
4327 mejdrech 398
     *           I would never expect to find so many errors in
399
     *           a compiler.
1536 palkovsky 400
     */
4327 mejdrech 401
    connection_t *conn = FIBRIL_connection;
402
 
1427 palkovsky 403
    futex_down(&async_futex);
4327 mejdrech 404
 
1500 palkovsky 405
    if (usecs) {
1536 palkovsky 406
        gettimeofday(&conn->wdata.expires, NULL);
407
        tv_add(&conn->wdata.expires, usecs);
4327 mejdrech 408
    } else
409
        conn->wdata.inlist = false;
410
 
2488 jermar 411
    /* If nothing in queue, wait until something arrives */
1536 palkovsky 412
    while (list_empty(&conn->msg_queue)) {
1610 palkovsky 413
        if (usecs)
1536 palkovsky 414
            insert_timeout(&conn->wdata);
4327 mejdrech 415
 
416
        conn->wdata.active = false;
417
 
2492 jermar 418
        /*
419
         * Note: the current fibril will be rescheduled either due to a
420
         * timeout or due to an arriving message destined to it. In the
421
         * former case, handle_expired_timeouts() and, in the latter
422
         * case, route_call() will perform the wakeup.
423
         */
2568 jermar 424
        fibril_switch(FIBRIL_TO_MANAGER);
4327 mejdrech 425
 
2488 jermar 426
        /*
4327 mejdrech 427
         * Futex is up after getting back from async_manager.
428
         * Get it again.
2492 jermar 429
         */
1500 palkovsky 430
        futex_down(&async_futex);
4327 mejdrech 431
        if ((usecs) && (conn->wdata.timedout)
432
            && (list_empty(&conn->msg_queue))) {
2488 jermar 433
            /* If we timed out -> exit */
1500 palkovsky 434
            futex_up(&async_futex);
435
            return 0;
436
        }
1351 palkovsky 437
    }
438
 
4327 mejdrech 439
    msg_t *msg = list_get_instance(conn->msg_queue.next, msg_t, link);
1392 palkovsky 440
    list_remove(&msg->link);
4327 mejdrech 441
 
442
    ipc_callid_t callid = msg->callid;
1392 palkovsky 443
    *call = msg->call;
444
    free(msg);
445
 
1427 palkovsky 446
    futex_up(&async_futex);
1392 palkovsky 447
    return callid;
1351 palkovsky 448
}
449
 
2490 jermar 450
/** Default fibril function that gets called to handle new connection.
1404 palkovsky 451
 *
2488 jermar 452
 * This function is defined as a weak symbol - to be redefined in user code.
2490 jermar 453
 *
4327 mejdrech 454
 * @param callid Hash of the incoming call.
455
 * @param call   Data of the incoming call.
456
 *
1404 palkovsky 457
 */
1490 palkovsky 458
static void default_client_connection(ipc_callid_t callid, ipc_call_t *call)
1392 palkovsky 459
{
2619 jermar 460
    ipc_answer_0(callid, ENOENT);
1392 palkovsky 461
}
2490 jermar 462
 
463
/** Default fibril function that gets called to handle interrupt notifications.
464
 *
4327 mejdrech 465
 * This function is defined as a weak symbol - to be redefined in user code.
466
 *
467
 * @param callid Hash of the incoming call.
468
 * @param call   Data of the incoming call.
469
 *
2490 jermar 470
 */
1596 palkovsky 471
static void default_interrupt_received(ipc_callid_t callid, ipc_call_t *call)
1452 palkovsky 472
{
473
}
474
 
2485 jermar 475
/** Wrapper for client connection fibril.
1404 palkovsky 476
 *
2490 jermar 477
 * When a new connection arrives, a fibril with this implementing function is
2485 jermar 478
 * created. It calls client_connection() and does the final cleanup.
1404 palkovsky 479
 *
4327 mejdrech 480
 * @param arg Connection structure pointer.
2485 jermar 481
 *
4327 mejdrech 482
 * @return Always zero.
483
 *
1404 palkovsky 484
 */
4327 mejdrech 485
static int connection_fibril(void *arg)
1351 palkovsky 486
{
4327 mejdrech 487
    /*
488
     * Setup fibril-local connection pointer and call client_connection().
489
     *
490
     */
2482 jermar 491
    FIBRIL_connection = (connection_t *) arg;
492
    FIBRIL_connection->cfibril(FIBRIL_connection->callid,
493
        &FIBRIL_connection->call);
1719 decky 494
 
2490 jermar 495
    /* Remove myself from the connection hash table */
1427 palkovsky 496
    futex_down(&async_futex);
4327 mejdrech 497
    unsigned long key = FIBRIL_connection->in_phone_hash;
1404 palkovsky 498
    hash_table_remove(&conn_hash_table, &key, 1);
1427 palkovsky 499
    futex_up(&async_futex);
1719 decky 500
 
2490 jermar 501
    /* Answer all remaining messages with EHANGUP */
2482 jermar 502
    while (!list_empty(&FIBRIL_connection->msg_queue)) {
4327 mejdrech 503
        msg_t *msg
504
            = list_get_instance(FIBRIL_connection->msg_queue.next, msg_t, link);
505
 
1404 palkovsky 506
        list_remove(&msg->link);
2619 jermar 507
        ipc_answer_0(msg->callid, EHANGUP);
1404 palkovsky 508
        free(msg);
509
    }
4327 mejdrech 510
 
2482 jermar 511
    if (FIBRIL_connection->close_callid)
2619 jermar 512
        ipc_answer_0(FIBRIL_connection->close_callid, EOK);
1719 decky 513
 
514
    return 0;
1351 palkovsky 515
}
1392 palkovsky 516
 
2485 jermar 517
/** Create a new fibril for a new connection.
1392 palkovsky 518
 *
4327 mejdrech 519
 * Create new fibril for connection, fill in connection structures and inserts
2485 jermar 520
 * it into the hash table, so that later we can easily do routing of messages to
521
 * particular fibrils.
1407 palkovsky 522
 *
4327 mejdrech 523
 * @param in_phone_hash Identification of the incoming connection.
524
 * @param callid        Hash of the opening IPC_M_CONNECT_ME_TO call.
525
 *                      If callid is zero, the connection was opened by
526
 *                      accepting the IPC_M_CONNECT_TO_ME call and this function
527
 *                      is called directly by the server.
528
 * @param call          Call data of the opening call.
529
 * @param cfibril       Fibril function that should be called upon opening the
530
 *                      connection.
2490 jermar 531
 *
4327 mejdrech 532
 * @return New fibril id or NULL on failure.
533
 *
1392 palkovsky 534
 */
2482 jermar 535
fid_t async_new_connection(ipcarg_t in_phone_hash, ipc_callid_t callid,
536
    ipc_call_t *call, void (*cfibril)(ipc_callid_t, ipc_call_t *))
1392 palkovsky 537
{
4327 mejdrech 538
    connection_t *conn = malloc(sizeof(*conn));
1392 palkovsky 539
    if (!conn) {
2534 jermar 540
        if (callid)
2619 jermar 541
            ipc_answer_0(callid, ENOMEM);
1407 palkovsky 542
        return NULL;
1392 palkovsky 543
    }
4327 mejdrech 544
 
1452 palkovsky 545
    conn->in_phone_hash = in_phone_hash;
1392 palkovsky 546
    list_initialize(&conn->msg_queue);
547
    conn->callid = callid;
4327 mejdrech 548
    conn->close_callid = false;
549
 
1453 palkovsky 550
    if (call)
551
        conn->call = *call;
4327 mejdrech 552
 
553
    /* We will activate the fibril ASAP */
554
    conn->wdata.active = true;
2482 jermar 555
    conn->cfibril = cfibril;
4327 mejdrech 556
    conn->wdata.fid = fibril_create(connection_fibril, conn);
4153 mejdrech 557
 
2482 jermar 558
    if (!conn->wdata.fid) {
1392 palkovsky 559
        free(conn);
2534 jermar 560
        if (callid)
2619 jermar 561
            ipc_answer_0(callid, ENOMEM);
1407 palkovsky 562
        return NULL;
1392 palkovsky 563
    }
4153 mejdrech 564
 
2490 jermar 565
    /* Add connection to the connection hash table */
4327 mejdrech 566
    ipcarg_t key = conn->in_phone_hash;
567
 
1427 palkovsky 568
    futex_down(&async_futex);
1392 palkovsky 569
    hash_table_insert(&conn_hash_table, &key, &conn->link);
1427 palkovsky 570
    futex_up(&async_futex);
4153 mejdrech 571
 
2482 jermar 572
    fibril_add_ready(conn->wdata.fid);
4153 mejdrech 573
 
2482 jermar 574
    return conn->wdata.fid;
1392 palkovsky 575
}
576
 
2490 jermar 577
/** Handle a call that was received.
578
 *
579
 * If the call has the IPC_M_CONNECT_ME_TO method, a new connection is created.
580
 * Otherwise the call is routed to its connection fibril.
581
 *
4327 mejdrech 582
 * @param callid Hash of the incoming call.
583
 * @param call   Data of the incoming call.
4153 mejdrech 584
 *
2490 jermar 585
 */
1392 palkovsky 586
static void handle_call(ipc_callid_t callid, ipc_call_t *call)
587
{
1452 palkovsky 588
    /* Unrouted call - do some default behaviour */
1694 palkovsky 589
    if ((callid & IPC_CALLID_NOTIFICATION)) {
4327 mejdrech 590
        process_notification(callid, call);
1452 palkovsky 591
        return;
4153 mejdrech 592
    }
593
 
1694 palkovsky 594
    switch (IPC_GET_METHOD(*call)) {
1392 palkovsky 595
    case IPC_M_CONNECT_ME_TO:
2485 jermar 596
        /* Open new connection with fibril etc. */
2635 cejka 597
        async_new_connection(IPC_GET_ARG5(*call), callid, call,
2482 jermar 598
            client_connection);
1452 palkovsky 599
        return;
1392 palkovsky 600
    }
4153 mejdrech 601
 
2490 jermar 602
    /* Try to route the call through the connection hash table */
1452 palkovsky 603
    if (route_call(callid, call))
604
        return;
4153 mejdrech 605
 
1452 palkovsky 606
    /* Unknown call from unknown phone - hang it up */
2619 jermar 607
    ipc_answer_0(callid, EHANGUP);
1392 palkovsky 608
}
609
 
2485 jermar 610
/** Fire all timeouts that expired. */
1441 palkovsky 611
static void handle_expired_timeouts(void)
612
{
613
    struct timeval tv;
2490 jermar 614
    gettimeofday(&tv, NULL);
4327 mejdrech 615
 
1441 palkovsky 616
    futex_down(&async_futex);
4327 mejdrech 617
 
618
    link_t *cur = timeout_list.next;
1441 palkovsky 619
    while (cur != &timeout_list) {
4327 mejdrech 620
        awaiter_t *waiter = list_get_instance(cur, awaiter_t, link);
621
 
1500 palkovsky 622
        if (tv_gt(&waiter->expires, &tv))
1441 palkovsky 623
            break;
4327 mejdrech 624
 
1441 palkovsky 625
        cur = cur->next;
4327 mejdrech 626
 
1500 palkovsky 627
        list_remove(&waiter->link);
4327 mejdrech 628
        waiter->inlist = false;
629
        waiter->timedout = true;
630
 
2490 jermar 631
        /*
4327 mejdrech 632
         * Redundant condition?
633
         * The fibril should not be active when it gets here.
1441 palkovsky 634
         */
1500 palkovsky 635
        if (!waiter->active) {
4327 mejdrech 636
            waiter->active = true;
2482 jermar 637
            fibril_add_ready(waiter->fid);
1441 palkovsky 638
        }
639
    }
4327 mejdrech 640
 
1441 palkovsky 641
    futex_up(&async_futex);
642
}
643
 
2490 jermar 644
/** Endless loop dispatching incoming calls and answers.
645
 *
4327 mejdrech 646
 * @return Never returns.
647
 *
2490 jermar 648
 */
1610 palkovsky 649
static int async_manager_worker(void)
1392 palkovsky 650
{
4327 mejdrech 651
    while (true) {
2568 jermar 652
        if (fibril_switch(FIBRIL_FROM_MANAGER)) {
1719 decky 653
            futex_up(&async_futex);
2490 jermar 654
            /*
655
             * async_futex is always held when entering a manager
656
             * fibril.
1719 decky 657
             */
1392 palkovsky 658
            continue;
659
        }
4327 mejdrech 660
 
1441 palkovsky 661
        futex_down(&async_futex);
4327 mejdrech 662
 
663
        suseconds_t timeout;
1441 palkovsky 664
        if (!list_empty(&timeout_list)) {
4327 mejdrech 665
            awaiter_t *waiter
666
                = list_get_instance(timeout_list.next, awaiter_t, link);
667
 
668
            struct timeval tv;
2482 jermar 669
            gettimeofday(&tv, NULL);
4327 mejdrech 670
 
1500 palkovsky 671
            if (tv_gteq(&tv, &waiter->expires)) {
1536 palkovsky 672
                futex_up(&async_futex);
1441 palkovsky 673
                handle_expired_timeouts();
674
                continue;
675
            } else
1500 palkovsky 676
                timeout = tv_sub(&waiter->expires, &tv);
1441 palkovsky 677
        } else
1435 palkovsky 678
            timeout = SYNCH_NO_TIMEOUT;
4327 mejdrech 679
 
1441 palkovsky 680
        futex_up(&async_futex);
4327 mejdrech 681
 
682
        ipc_call_t call;
683
        ipc_callid_t callid
684
            = ipc_wait_cycle(&call, timeout, SYNCH_FLAGS_NONE);
685
 
1435 palkovsky 686
        if (!callid) {
1441 palkovsky 687
            handle_expired_timeouts();
1435 palkovsky 688
            continue;
689
        }
4327 mejdrech 690
 
691
        if (callid & IPC_CALLID_ANSWERED)
1392 palkovsky 692
            continue;
4327 mejdrech 693
 
1392 palkovsky 694
        handle_call(callid, &call);
695
    }
1719 decky 696
 
697
    return 0;
1392 palkovsky 698
}
699
 
2490 jermar 700
/** Function to start async_manager as a standalone fibril.
4327 mejdrech 701
 *
2490 jermar 702
 * When more kernel threads are used, one async manager should exist per thread.
703
 *
4327 mejdrech 704
 * @param arg Unused.
705
 * @return Never returns.
2490 jermar 706
 *
1404 palkovsky 707
 */
2484 jermar 708
static int async_manager_fibril(void *arg)
1392 palkovsky 709
{
1719 decky 710
    futex_up(&async_futex);
4327 mejdrech 711
 
2490 jermar 712
    /*
713
     * async_futex is always locked when entering manager
714
     */
1610 palkovsky 715
    async_manager_worker();
1719 decky 716
 
717
    return 0;
1392 palkovsky 718
}
719
 
2490 jermar 720
/** Add one manager to manager list. */
1392 palkovsky 721
void async_create_manager(void)
722
{
4327 mejdrech 723
    fid_t fid = fibril_create(async_manager_fibril, NULL);
2482 jermar 724
    fibril_add_manager(fid);
1392 palkovsky 725
}
726
 
727
/** Remove one manager from manager list */
728
void async_destroy_manager(void)
729
{
2482 jermar 730
    fibril_remove_manager();
1392 palkovsky 731
}
732
 
2490 jermar 733
/** Initialize the async framework.
734
 *
4327 mejdrech 735
 * @return Zero on success or an error code.
2490 jermar 736
 */
1392 palkovsky 737
int _async_init(void)
738
{
2482 jermar 739
    if (!hash_table_create(&conn_hash_table, CONN_HASH_TABLE_CHAINS, 1,
740
        &conn_hash_table_ops)) {
1392 palkovsky 741
        printf("%s: cannot create hash table\n", "async");
742
        return ENOMEM;
743
    }
744
 
1719 decky 745
    return 0;
1392 palkovsky 746
}
1427 palkovsky 747
 
2490 jermar 748
/** Reply received callback.
1427 palkovsky 749
 *
2490 jermar 750
 * This function is called whenever a reply for an asynchronous message sent out
751
 * by the asynchronous framework is received.
752
 *
753
 * Notify the fibril which is waiting for this message that it has arrived.
754
 *
4327 mejdrech 755
 * @param arg    Pointer to the asynchronous message record.
756
 * @param retval Value returned in the answer.
757
 * @param data   Call data of the answer.
1427 palkovsky 758
 */
4327 mejdrech 759
static void reply_received(void *arg, int retval, ipc_call_t *data)
1427 palkovsky 760
{
4327 mejdrech 761
    amsg_t *msg = (amsg_t *) arg;
1427 palkovsky 762
    msg->retval = retval;
4327 mejdrech 763
 
1427 palkovsky 764
    futex_down(&async_futex);
4327 mejdrech 765
 
2490 jermar 766
    /* Copy data after futex_down, just in case the call was detached */
1427 palkovsky 767
    if (msg->dataptr)
4327 mejdrech 768
        *msg->dataptr = *data;
769
 
1441 palkovsky 770
    write_barrier();
4327 mejdrech 771
 
1441 palkovsky 772
    /* Remove message from timeout list */
1500 palkovsky 773
    if (msg->wdata.inlist)
774
        list_remove(&msg->wdata.link);
4327 mejdrech 775
 
776
    msg->done = true;
2490 jermar 777
    if (!msg->wdata.active) {
4327 mejdrech 778
        msg->wdata.active = true;
2482 jermar 779
        fibril_add_ready(msg->wdata.fid);
1427 palkovsky 780
    }
4327 mejdrech 781
 
1427 palkovsky 782
    futex_up(&async_futex);
783
}
784
 
2490 jermar 785
/** Send message and return id of the sent message.
1427 palkovsky 786
 *
2490 jermar 787
 * The return value can be used as input for async_wait() to wait for
788
 * completion.
789
 *
4327 mejdrech 790
 * @param phoneid Handle of the phone that will be used for the send.
791
 * @param method  Service-defined method.
792
 * @param arg1    Service-defined payload argument.
793
 * @param arg2    Service-defined payload argument.
794
 * @param arg3    Service-defined payload argument.
795
 * @param arg4    Service-defined payload argument.
796
 * @param dataptr If non-NULL, storage where the reply data will be
797
 *                stored.
2490 jermar 798
 *
4327 mejdrech 799
 * @return Hash of the sent message or 0 on error.
800
 *
1427 palkovsky 801
 */
2621 jermar 802
aid_t async_send_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
803
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipc_call_t *dataptr)
1427 palkovsky 804
{
4327 mejdrech 805
    amsg_t *msg = malloc(sizeof(*msg));
4153 mejdrech 806
 
4327 mejdrech 807
    if (!msg)
808
        return 0;
809
 
810
    msg->done = false;
1427 palkovsky 811
    msg->dataptr = dataptr;
4153 mejdrech 812
 
2490 jermar 813
    /* We may sleep in the next method, but it will use its own mechanism */
4327 mejdrech 814
    msg->wdata.active = true;
815
 
2621 jermar 816
    ipc_call_async_4(phoneid, method, arg1, arg2, arg3, arg4, msg,
4327 mejdrech 817
        reply_received, true);
4153 mejdrech 818
 
1427 palkovsky 819
    return (aid_t) msg;
820
}
821
 
1547 palkovsky 822
/** Send message and return id of the sent message
823
 *
2490 jermar 824
 * The return value can be used as input for async_wait() to wait for
825
 * completion.
826
 *
4327 mejdrech 827
 * @param phoneid Handle of the phone that will be used for the send.
828
 * @param method  Service-defined method.
829
 * @param arg1    Service-defined payload argument.
830
 * @param arg2    Service-defined payload argument.
831
 * @param arg3    Service-defined payload argument.
832
 * @param arg4    Service-defined payload argument.
833
 * @param arg5    Service-defined payload argument.
834
 * @param dataptr If non-NULL, storage where the reply data will be
835
 *                stored.
2490 jermar 836
 *
4327 mejdrech 837
 * @return Hash of the sent message or 0 on error.
838
 *
1547 palkovsky 839
 */
2621 jermar 840
aid_t async_send_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
841
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5,
842
    ipc_call_t *dataptr)
1547 palkovsky 843
{
4327 mejdrech 844
    amsg_t *msg = malloc(sizeof(*msg));
4153 mejdrech 845
 
4327 mejdrech 846
    if (!msg)
847
        return 0;
848
 
849
    msg->done = false;
1547 palkovsky 850
    msg->dataptr = dataptr;
4153 mejdrech 851
 
2490 jermar 852
    /* We may sleep in next method, but it will use its own mechanism */
4327 mejdrech 853
    msg->wdata.active = true;
4153 mejdrech 854
 
2621 jermar 855
    ipc_call_async_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, msg,
4327 mejdrech 856
        reply_received, true);
4153 mejdrech 857
 
1547 palkovsky 858
    return (aid_t) msg;
859
}
860
 
2490 jermar 861
/** Wait for a message sent by the async framework.
1427 palkovsky 862
 *
4327 mejdrech 863
 * @param amsgid Hash of the message to wait for.
864
 * @param retval Pointer to storage where the retval of the answer will
865
 *               be stored.
866
 *
1427 palkovsky 867
 */
868
void async_wait_for(aid_t amsgid, ipcarg_t *retval)
869
{
870
    amsg_t *msg = (amsg_t *) amsgid;
4327 mejdrech 871
 
1427 palkovsky 872
    futex_down(&async_futex);
873
    if (msg->done) {
874
        futex_up(&async_futex);
875
        goto done;
876
    }
4327 mejdrech 877
 
2482 jermar 878
    msg->wdata.fid = fibril_get_id();
4327 mejdrech 879
    msg->wdata.active = false;
880
    msg->wdata.inlist = false;
881
 
2490 jermar 882
    /* Leave the async_futex locked when entering this function */
2568 jermar 883
    fibril_switch(FIBRIL_TO_MANAGER);
4327 mejdrech 884
 
885
    /* Futex is up automatically after fibril_switch */
886
 
1427 palkovsky 887
done:
888
    if (retval)
889
        *retval = msg->retval;
4327 mejdrech 890
 
1427 palkovsky 891
    free(msg);
892
}
1435 palkovsky 893
 
2490 jermar 894
/** Wait for a message sent by the async framework, timeout variant.
1441 palkovsky 895
 *
4327 mejdrech 896
 * @param amsgid  Hash of the message to wait for.
897
 * @param retval  Pointer to storage where the retval of the answer will
898
 *                be stored.
899
 * @param timeout Timeout in microseconds.
1441 palkovsky 900
 *
4327 mejdrech 901
 * @return Zero on success, ETIMEOUT if the timeout has expired.
902
 *
1441 palkovsky 903
 */
904
int async_wait_timeout(aid_t amsgid, ipcarg_t *retval, suseconds_t timeout)
905
{
906
    amsg_t *msg = (amsg_t *) amsgid;
4327 mejdrech 907
 
1532 palkovsky 908
    /* TODO: Let it go through the event read at least once */
909
    if (timeout < 0)
910
        return ETIMEOUT;
4327 mejdrech 911
 
1441 palkovsky 912
    futex_down(&async_futex);
913
    if (msg->done) {
914
        futex_up(&async_futex);
915
        goto done;
916
    }
4327 mejdrech 917
 
1500 palkovsky 918
    gettimeofday(&msg->wdata.expires, NULL);
919
    tv_add(&msg->wdata.expires, timeout);
4327 mejdrech 920
 
2482 jermar 921
    msg->wdata.fid = fibril_get_id();
4327 mejdrech 922
    msg->wdata.active = false;
1500 palkovsky 923
    insert_timeout(&msg->wdata);
4327 mejdrech 924
 
2490 jermar 925
    /* Leave the async_futex locked when entering this function */
2568 jermar 926
    fibril_switch(FIBRIL_TO_MANAGER);
4327 mejdrech 927
 
928
    /* Futex is up automatically after fibril_switch */
929
 
1441 palkovsky 930
    if (!msg->done)
931
        return ETIMEOUT;
4327 mejdrech 932
 
1441 palkovsky 933
done:
934
    if (retval)
935
        *retval = msg->retval;
4327 mejdrech 936
 
1441 palkovsky 937
    free(msg);
4327 mejdrech 938
 
1441 palkovsky 939
    return 0;
940
}
941
 
2490 jermar 942
/** Wait for specified time.
1452 palkovsky 943
 *
2490 jermar 944
 * The current fibril is suspended but the thread continues to execute.
945
 *
4327 mejdrech 946
 * @param timeout Duration of the wait in microseconds.
947
 *
1452 palkovsky 948
 */
949
void async_usleep(suseconds_t timeout)
950
{
4327 mejdrech 951
    amsg_t *msg = malloc(sizeof(*msg));
1452 palkovsky 952
 
953
    if (!msg)
954
        return;
4153 mejdrech 955
 
2482 jermar 956
    msg->wdata.fid = fibril_get_id();
4327 mejdrech 957
    msg->wdata.active = false;
4153 mejdrech 958
 
1500 palkovsky 959
    gettimeofday(&msg->wdata.expires, NULL);
960
    tv_add(&msg->wdata.expires, timeout);
4153 mejdrech 961
 
1452 palkovsky 962
    futex_down(&async_futex);
4327 mejdrech 963
 
1500 palkovsky 964
    insert_timeout(&msg->wdata);
4327 mejdrech 965
 
2490 jermar 966
    /* Leave the async_futex locked when entering this function */
2568 jermar 967
    fibril_switch(FIBRIL_TO_MANAGER);
4327 mejdrech 968
 
969
    /* Futex is up automatically after fibril_switch() */
970
 
1452 palkovsky 971
    free(msg);
972
}
1490 palkovsky 973
 
2490 jermar 974
/** Setter for client_connection function pointer.
1490 palkovsky 975
 *
4327 mejdrech 976
 * @param conn Function that will implement a new connection fibril.
977
 *
1490 palkovsky 978
 */
979
void async_set_client_connection(async_client_conn_t conn)
980
{
981
    client_connection = conn;
982
}
2490 jermar 983
 
984
/** Setter for interrupt_received function pointer.
985
 *
4327 mejdrech 986
 * @param intr Function that will implement a new interrupt
987
 *             notification fibril.
2490 jermar 988
 */
4327 mejdrech 989
void async_set_interrupt_received(async_client_conn_t intr)
1596 palkovsky 990
{
4327 mejdrech 991
    interrupt_received = intr;
1596 palkovsky 992
}
1610 palkovsky 993
 
2621 jermar 994
/** Pseudo-synchronous message sending - fast version.
995
 *
996
 * Send message asynchronously and return only after the reply arrives.
997
 *
998
 * This function can only transfer 4 register payload arguments. For
999
 * transferring more arguments, see the slower async_req_slow().
1000
 *
4327 mejdrech 1001
 * @param phoneid Hash of the phone through which to make the call.
1002
 * @param method  Method of the call.
1003
 * @param arg1    Service-defined payload argument.
1004
 * @param arg2    Service-defined payload argument.
1005
 * @param arg3    Service-defined payload argument.
1006
 * @param arg4    Service-defined payload argument.
1007
 * @param r1      If non-NULL, storage for the 1st reply argument.
1008
 * @param r2      If non-NULL, storage for the 2nd reply argument.
1009
 * @param r3      If non-NULL, storage for the 3rd reply argument.
1010
 * @param r4      If non-NULL, storage for the 4th reply argument.
1011
 * @param r5      If non-NULL, storage for the 5th reply argument.
1012
 *
1013
 * @return Return code of the reply or a negative error code.
1014
 *
2621 jermar 1015
 */
1016
ipcarg_t async_req_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
1017
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t *r1, ipcarg_t *r2,
1018
    ipcarg_t *r3, ipcarg_t *r4, ipcarg_t *r5)
1610 palkovsky 1019
{
2621 jermar 1020
    ipc_call_t result;
1021
    aid_t eid = async_send_4(phoneid, method, arg1, arg2, arg3, arg4,
1022
        &result);
4327 mejdrech 1023
 
1024
    ipcarg_t rc;
2621 jermar 1025
    async_wait_for(eid, &rc);
4327 mejdrech 1026
 
1027
    if (r1)
2621 jermar 1028
        *r1 = IPC_GET_ARG1(result);
4327 mejdrech 1029
 
2621 jermar 1030
    if (r2)
1031
        *r2 = IPC_GET_ARG2(result);
4327 mejdrech 1032
 
2621 jermar 1033
    if (r3)
1034
        *r3 = IPC_GET_ARG3(result);
4327 mejdrech 1035
 
2621 jermar 1036
    if (r4)
1037
        *r4 = IPC_GET_ARG4(result);
4327 mejdrech 1038
 
2621 jermar 1039
    if (r5)
1040
        *r5 = IPC_GET_ARG5(result);
4327 mejdrech 1041
 
2621 jermar 1042
    return rc;
1610 palkovsky 1043
}
1044
 
2621 jermar 1045
/** Pseudo-synchronous message sending - slow version.
1046
 *
1047
 * Send message asynchronously and return only after the reply arrives.
1048
 *
4327 mejdrech 1049
 * @param phoneid Hash of the phone through which to make the call.
1050
 * @param method  Method of the call.
1051
 * @param arg1    Service-defined payload argument.
1052
 * @param arg2    Service-defined payload argument.
1053
 * @param arg3    Service-defined payload argument.
1054
 * @param arg4    Service-defined payload argument.
1055
 * @param arg5    Service-defined payload argument.
1056
 * @param r1      If non-NULL, storage for the 1st reply argument.
1057
 * @param r2      If non-NULL, storage for the 2nd reply argument.
1058
 * @param r3      If non-NULL, storage for the 3rd reply argument.
1059
 * @param r4      If non-NULL, storage for the 4th reply argument.
1060
 * @param r5      If non-NULL, storage for the 5th reply argument.
1061
 *
1062
 * @return Return code of the reply or a negative error code.
1063
 *
2621 jermar 1064
 */
1065
ipcarg_t async_req_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
1066
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5, ipcarg_t *r1,
1067
    ipcarg_t *r2, ipcarg_t *r3, ipcarg_t *r4, ipcarg_t *r5)
1610 palkovsky 1068
{
2621 jermar 1069
    ipc_call_t result;
1070
    aid_t eid = async_send_5(phoneid, method, arg1, arg2, arg3, arg4, arg5,
1071
        &result);
4327 mejdrech 1072
 
1073
    ipcarg_t rc;
2621 jermar 1074
    async_wait_for(eid, &rc);
4327 mejdrech 1075
 
1076
    if (r1)
2621 jermar 1077
        *r1 = IPC_GET_ARG1(result);
4327 mejdrech 1078
 
2621 jermar 1079
    if (r2)
1080
        *r2 = IPC_GET_ARG2(result);
4327 mejdrech 1081
 
2621 jermar 1082
    if (r3)
1083
        *r3 = IPC_GET_ARG3(result);
4327 mejdrech 1084
 
2621 jermar 1085
    if (r4)
1086
        *r4 = IPC_GET_ARG4(result);
4327 mejdrech 1087
 
2621 jermar 1088
    if (r5)
1089
        *r5 = IPC_GET_ARG5(result);
4327 mejdrech 1090
 
2621 jermar 1091
    return rc;
1610 palkovsky 1092
}
1653 cejka 1093
 
1719 decky 1094
/** @}
1653 cejka 1095
 */