Subversion Repositories HelenOS

Rev

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