source: mainline/uspace/lib/c/generic/async/server.c@ f92b315

Last change on this file since f92b315 was 012dd8e, checked in by Matthieu Riolo <matthieu.riolo@…>, 6 years ago

taskman: Handle INIT_TASKS as tasks spawned by loader

  • everyone is connected to its spawner, except for INIT_TASKS, they are connected to taskman (first binary)
  • taskman is now aware even of INIT_TASKS and taskman itself
  • refactored taskman handshake — NS session is created lazily
  • refactored async.c with usage of create_session
  • changed EINVAL to EINTR on lost waits
  • removed TODOs from taskman and related libc TODOs

Conflicts:

abi/include/abi/ipc/methods.h
boot/Makefile.common
uspace/lib/c/generic/async.c
uspace/lib/c/generic/libc.c
uspace/lib/c/generic/loader.c
uspace/lib/c/generic/ns.c
uspace/lib/c/generic/private/async.h
uspace/lib/c/generic/private/taskman.h
uspace/lib/c/generic/task.c
uspace/lib/c/include/async.h
uspace/lib/c/include/task.h
uspace/srv/loader/main.c
uspace/srv/ns/ns.c

  • Property mode set to 100644
File size: 45.4 KB
Line 
1/*
2 * Copyright (c) 2006 Ondrej 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.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32/** @file
33 */
34
35/**
36 * Asynchronous library
37 *
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.
41 *
42 * You should be able to write very simple multithreaded programs. The async
43 * framework will automatically take care of most of the synchronization
44 * problems.
45 *
46 * Example of use (pseudo C):
47 *
48 * 1) Multithreaded client application
49 *
50 * fibril_create(fibril1, ...);
51 * fibril_create(fibril2, ...);
52 * ...
53 *
54 * int fibril1(void *arg)
55 * {
56 * conn = async_connect_me_to(...);
57 *
58 * exch = async_exchange_begin(conn);
59 * c1 = async_send(exch);
60 * async_exchange_end(exch);
61 *
62 * exch = async_exchange_begin(conn);
63 * c2 = async_send(exch);
64 * async_exchange_end(exch);
65 *
66 * async_wait_for(c1);
67 * async_wait_for(c2);
68 * ...
69 * }
70 *
71 *
72 * 2) Multithreaded server application
73 *
74 * main()
75 * {
76 * async_manager();
77 * }
78 *
79 * port_handler(ipc_call_t *icall)
80 * {
81 * if (want_refuse) {
82 * async_answer_0(icall, ELIMIT);
83 * return;
84 * }
85 *
86 * async_answer_0(icall, EOK);
87 *
88 * async_get_call(&call);
89 * somehow_handle_the_call(&call);
90 * async_answer_2(&call, 1, 2, 3);
91 *
92 * async_get_call(&call);
93 * ...
94 * }
95 *
96 */
97
98#define _LIBC_ASYNC_C_
99#include <ipc/ipc.h>
100#include <async.h>
101#include "../private/async.h"
102#undef _LIBC_ASYNC_C_
103
104#include <ipc/irq.h>
105#include <ipc/event.h>
106#include <fibril.h>
107#include <adt/hash_table.h>
108#include <adt/hash.h>
109#include <adt/list.h>
110#include <assert.h>
111#include <errno.h>
112#include <time.h>
113#include <stdbool.h>
114#include <stdlib.h>
115#include <mem.h>
116#include <stdlib.h>
117#include <macros.h>
118#include <str_error.h>
119#include <as.h>
120#include <abi/mm/as.h>
121#include "../private/libc.h"
122#include "../private/fibril.h"
123
124#define DPRINTF(...) ((void) 0)
125
126/* Client connection data */
127typedef struct {
128 ht_link_t link;
129
130 task_id_t in_task_id;
131 int refcnt;
132 void *data;
133} client_t;
134
135/* Server connection data */
136typedef struct {
137 /** Fibril handling the connection. */
138 fid_t fid;
139
140 /** Hash table link. */
141 ht_link_t link;
142
143 /** Incoming client task ID. */
144 task_id_t in_task_id;
145
146 /** Link to the client tracking structure. */
147 client_t *client;
148
149 /** Channel for messages that should be delivered to this fibril. */
150 mpsc_t *msg_channel;
151
152 /** Call data of the opening call. */
153 ipc_call_t call;
154
155 /** Fibril function that will be used to handle the connection. */
156 async_port_handler_t handler;
157
158 /** Client data */
159 void *data;
160} connection_t;
161
162/* Member of notification_t::msg_list. */
163typedef struct {
164 link_t link;
165 ipc_call_t calldata;
166} notification_msg_t;
167
168/* Notification data */
169typedef struct {
170 /** notification_hash_table link */
171 ht_link_t htlink;
172
173 /** notification_queue link */
174 link_t qlink;
175
176 /** Notification method */
177 sysarg_t imethod;
178
179 /** Notification handler */
180 async_notification_handler_t handler;
181
182 /** Notification handler argument */
183 void *arg;
184
185 /** List of arrived notifications. */
186 list_t msg_list;
187} notification_t;
188
189/** Identifier of the incoming connection handled by the current fibril. */
190static fibril_local connection_t *fibril_connection;
191
192static void *default_client_data_constructor(void)
193{
194 return NULL;
195}
196
197static void default_client_data_destructor(void *data)
198{
199}
200
201static async_client_data_ctor_t async_client_data_create =
202 default_client_data_constructor;
203static async_client_data_dtor_t async_client_data_destroy =
204 default_client_data_destructor;
205
206void async_set_client_data_constructor(async_client_data_ctor_t ctor)
207{
208 assert(async_client_data_create == default_client_data_constructor);
209 async_client_data_create = ctor;
210}
211
212void async_set_client_data_destructor(async_client_data_dtor_t dtor)
213{
214 assert(async_client_data_destroy == default_client_data_destructor);
215 async_client_data_destroy = dtor;
216}
217
218static async_client_conn_t implicit_connection = NULL;
219static fibril_rmutex_t client_mutex;
220static hash_table_t client_hash_table;
221
222// TODO: lockfree notification_queue?
223static fibril_rmutex_t notification_mutex;
224static hash_table_t notification_hash_table;
225static LIST_INITIALIZE(notification_queue);
226static FIBRIL_SEMAPHORE_INITIALIZE(notification_semaphore, 0);
227
228static LIST_INITIALIZE(notification_freelist);
229static long notification_freelist_total = 0;
230static long notification_freelist_used = 0;
231
232static sysarg_t notification_avail = 0;
233
234static size_t client_key_hash(const void *key)
235{
236 const task_id_t *in_task_id = key;
237 return *in_task_id;
238}
239
240static size_t client_hash(const ht_link_t *item)
241{
242 client_t *client = hash_table_get_inst(item, client_t, link);
243 return client_key_hash(&client->in_task_id);
244}
245
246static bool client_key_equal(const void *key, const ht_link_t *item)
247{
248 const task_id_t *in_task_id = key;
249 client_t *client = hash_table_get_inst(item, client_t, link);
250 return *in_task_id == client->in_task_id;
251}
252
253/** Operations for the client hash table. */
254static hash_table_ops_t client_hash_table_ops = {
255 .hash = client_hash,
256 .key_hash = client_key_hash,
257 .key_equal = client_key_equal,
258 .equal = NULL,
259 .remove_callback = NULL
260};
261
262static client_t *async_client_get(task_id_t client_id, bool create)
263{
264 client_t *client = NULL;
265
266 fibril_rmutex_lock(&client_mutex);
267 ht_link_t *link = hash_table_find(&client_hash_table, &client_id);
268 if (link) {
269 client = hash_table_get_inst(link, client_t, link);
270 client->refcnt++;
271 } else if (create) {
272 // TODO: move the malloc out of critical section
273 /* malloc() is rmutex safe. */
274 client = malloc(sizeof(client_t));
275 if (client) {
276 client->in_task_id = client_id;
277 client->data = async_client_data_create();
278
279 client->refcnt = 1;
280 hash_table_insert(&client_hash_table, &client->link);
281 }
282 }
283
284 fibril_rmutex_unlock(&client_mutex);
285 return client;
286}
287
288static void async_client_put(client_t *client)
289{
290 bool destroy;
291
292 fibril_rmutex_lock(&client_mutex);
293
294 if (--client->refcnt == 0) {
295 hash_table_remove(&client_hash_table, &client->in_task_id);
296 destroy = true;
297 } else
298 destroy = false;
299
300 fibril_rmutex_unlock(&client_mutex);
301
302 if (destroy) {
303 if (client->data)
304 async_client_data_destroy(client->data);
305
306 free(client);
307 }
308}
309
310/** Wrapper for client connection fibril.
311 *
312 * When a new connection arrives, a fibril with this implementing
313 * function is created.
314 *
315 * @param arg Connection structure pointer.
316 *
317 * @return Always zero.
318 *
319 */
320static errno_t connection_fibril(void *arg)
321{
322 assert(arg);
323
324 /*
325 * Setup fibril-local connection pointer.
326 */
327 fibril_connection = (connection_t *) arg;
328
329 mpsc_t *c = fibril_connection->msg_channel;
330
331 /*
332 * Add our reference for the current connection in the client task
333 * tracking structure. If this is the first reference, create and
334 * hash in a new tracking structure.
335 */
336
337 client_t *client = async_client_get(fibril_connection->in_task_id, true);
338 if (!client) {
339 ipc_answer_0(fibril_connection->call.cap_handle, ENOMEM);
340 goto out;
341 }
342
343 fibril_connection->client = client;
344
345 /*
346 * Call the connection handler function.
347 */
348 fibril_connection->handler(&fibril_connection->call,
349 fibril_connection->data);
350
351 /*
352 * Remove the reference for this client task connection.
353 */
354 async_client_put(client);
355
356 /*
357 * Close the channel, if it isn't closed already.
358 */
359 mpsc_close(c);
360
361 /*
362 * Answer all remaining messages with EHANGUP.
363 */
364 ipc_call_t call;
365 while (mpsc_receive(c, &call, NULL) == EOK)
366 ipc_answer_0(call.cap_handle, EHANGUP);
367
368 /*
369 * Clean up memory.
370 */
371out:
372 mpsc_destroy(c);
373 free(fibril_connection);
374 return EOK;
375}
376
377/** Return label usable during replies to IPC_M_CONNECT_ME_TO. */
378sysarg_t async_get_label(void)
379{
380 return (sysarg_t) fibril_connection;
381}
382
383/** Create a new fibril for a new connection.
384 *
385 * Create new fibril for connection, fill in connection structures and insert it
386 * into the hash table, so that later we can easily do routing of messages to
387 * particular fibrils.
388 *
389 * @param conn Pointer to the connection structure. Will be used as the
390 * label of the connected phone and request_label of incoming
391 * calls routed through that phone.
392 * @param in_task_id Identification of the incoming connection.
393 * @param call Call data of the opening call. If call is NULL, it's
394 * either a callback connection that was opened by
395 * accepting the IPC_M_CONNECT_TO_ME call.
396 * Alternatively, it is zero when we are opening
397 * implicit connection.
398 * @param handler Connection handler.
399 * @param data Client argument to pass to the connection handler.
400 *
401 * @return New fibril id or NULL on failure.
402 *
403 */
404static fid_t async_new_connection(connection_t *conn, task_id_t in_task_id,
405 ipc_call_t *call, async_port_handler_t handler, void *data)
406{
407 conn->in_task_id = in_task_id;
408 conn->msg_channel = mpsc_create(sizeof(ipc_call_t));
409 conn->handler = handler;
410 conn->data = data;
411
412 if (!conn->msg_channel)
413 goto error;
414
415 if (call)
416 conn->call = *call;
417 else
418 conn->call.cap_handle = CAP_NIL;
419
420 /* We will activate the fibril ASAP */
421 conn->fid = fibril_create(connection_fibril, conn);
422
423 if (conn->fid == 0)
424 goto error;
425
426 fibril_start(conn->fid);
427
428 return conn->fid;
429
430error:
431 if (conn->msg_channel)
432 mpsc_destroy(conn->msg_channel);
433 free(conn);
434
435 if (call)
436 ipc_answer_0(call->cap_handle, ENOMEM);
437
438 return (fid_t) NULL;
439}
440
441/** Wrapper for making IPC_M_CONNECT_TO_ME calls using the async framework.
442 *
443 * Ask through phone for a new connection to some service.
444 *
445 * @param exch Exchange for sending the message.
446 * @param iface Callback interface.
447 * @param arg1 User defined argument.
448 * @param arg2 User defined argument.
449 * @param handler Callback handler.
450 * @param data Handler data.
451 * @param port_id ID of the newly created port.
452 *
453 * @return Zero on success or an error code.
454 *
455 */
456errno_t async_create_callback_port(async_exch_t *exch, iface_t iface, sysarg_t arg1,
457 sysarg_t arg2, async_port_handler_t handler, void *data, port_id_t *port_id)
458{
459 if ((iface & IFACE_MOD_CALLBACK) != IFACE_MOD_CALLBACK)
460 return EINVAL;
461
462 if (exch == NULL)
463 return ENOENT;
464
465 connection_t *conn = calloc(1, sizeof(*conn));
466 if (!conn)
467 return ENOMEM;
468
469 ipc_call_t answer;
470 aid_t req = async_send_5(exch, IPC_M_CONNECT_TO_ME, iface, arg1, arg2,
471 0, (sysarg_t) conn, &answer);
472
473 errno_t rc;
474 async_wait_for(req, &rc);
475 if (rc != EOK) {
476 free(conn);
477 return rc;
478 }
479
480 rc = async_create_port_internal(iface, handler, data, port_id);
481 if (rc != EOK) {
482 free(conn);
483 return rc;
484 }
485
486 fid_t fid = async_new_connection(conn, answer.task_id, NULL, handler,
487 data);
488 if (fid == (fid_t) NULL)
489 return ENOMEM;
490
491 return EOK;
492}
493
494static size_t notification_key_hash(const void *key)
495{
496 const sysarg_t *id = key;
497 return *id;
498}
499
500static size_t notification_hash(const ht_link_t *item)
501{
502 notification_t *notification =
503 hash_table_get_inst(item, notification_t, htlink);
504 return notification_key_hash(&notification->imethod);
505}
506
507static bool notification_key_equal(const void *key, const ht_link_t *item)
508{
509 const sysarg_t *id = key;
510 notification_t *notification =
511 hash_table_get_inst(item, notification_t, htlink);
512 return *id == notification->imethod;
513}
514
515/** Operations for the notification hash table. */
516static hash_table_ops_t notification_hash_table_ops = {
517 .hash = notification_hash,
518 .key_hash = notification_key_hash,
519 .key_equal = notification_key_equal,
520 .equal = NULL,
521 .remove_callback = NULL
522};
523
524/** Try to route a call to an appropriate connection fibril.
525 *
526 * If the proper connection fibril is found, a message with the call is added to
527 * its message queue. If the fibril was not active, it is activated and all
528 * timeouts are unregistered.
529 *
530 * @param call Data of the incoming call.
531 *
532 * @return EOK if the call was successfully passed to the respective fibril.
533 * @return ENOENT if the call doesn't match any connection.
534 * @return Other error code if routing failed for other reasons.
535 *
536 */
537static errno_t route_call(ipc_call_t *call)
538{
539 assert(call);
540
541 connection_t *conn = (connection_t *) call->request_label;
542
543 if (!conn)
544 return ENOENT;
545
546 assert(conn->msg_channel);
547
548 errno_t rc = mpsc_send(conn->msg_channel, call);
549
550 if (ipc_get_imethod(call) == IPC_M_PHONE_HUNGUP) {
551 /* Close the channel, but let the connection fibril answer. */
552 mpsc_close(conn->msg_channel);
553 // FIXME: Ideally, we should be able to discard/answer the
554 // hungup message here and just close the channel without
555 // passing it out. Unfortunatelly, somehow that breaks
556 // handling of CPU exceptions.
557 }
558
559 return rc;
560}
561
562/** Function implementing the notification handler fibril. Never returns. */
563static errno_t notification_fibril_func(void *arg)
564{
565 (void) arg;
566
567 while (true) {
568 fibril_semaphore_down(&notification_semaphore);
569
570 fibril_rmutex_lock(&notification_mutex);
571
572 /*
573 * The semaphore ensures that if we get this far,
574 * the queue must be non-empty.
575 */
576 assert(!list_empty(&notification_queue));
577
578 notification_t *notification = list_get_instance(
579 list_first(&notification_queue), notification_t, qlink);
580
581 async_notification_handler_t handler = notification->handler;
582 void *arg = notification->arg;
583
584 notification_msg_t *m = list_pop(&notification->msg_list,
585 notification_msg_t, link);
586 assert(m);
587 ipc_call_t calldata = m->calldata;
588
589 notification_freelist_used--;
590
591 if (notification_freelist_total > 64 &&
592 notification_freelist_total > 2 * notification_freelist_used) {
593 /* Going to free the structure if we have too much. */
594 notification_freelist_total--;
595 } else {
596 /* Otherwise add to freelist. */
597 list_append(&m->link, &notification_freelist);
598 m = NULL;
599 }
600
601 if (list_empty(&notification->msg_list))
602 list_remove(&notification->qlink);
603
604 fibril_rmutex_unlock(&notification_mutex);
605
606 if (handler)
607 handler(&calldata, arg);
608
609 free(m);
610 }
611
612 /* Not reached. */
613 return EOK;
614}
615
616/**
617 * Creates a new dedicated fibril for handling notifications.
618 * By default, there is one such fibril. This function can be used to
619 * create more in order to increase the number of notification that can
620 * be processed concurrently.
621 *
622 * Currently, there is no way to destroy those fibrils after they are created.
623 */
624errno_t async_spawn_notification_handler(void)
625{
626 fid_t f = fibril_create(notification_fibril_func, NULL);
627 if (f == 0)
628 return ENOMEM;
629
630 fibril_add_ready(f);
631 return EOK;
632}
633
634/** Queue notification.
635 *
636 * @param call Data of the incoming call.
637 *
638 */
639static void queue_notification(ipc_call_t *call)
640{
641 assert(call);
642
643 fibril_rmutex_lock(&notification_mutex);
644
645 notification_msg_t *m = list_pop(&notification_freelist,
646 notification_msg_t, link);
647
648 if (!m) {
649 fibril_rmutex_unlock(&notification_mutex);
650 m = malloc(sizeof(notification_msg_t));
651 if (!m) {
652 DPRINTF("Out of memory.\n");
653 abort();
654 }
655
656 fibril_rmutex_lock(&notification_mutex);
657 notification_freelist_total++;
658 }
659
660 sysarg_t imethod = ipc_get_imethod(call);
661 ht_link_t *link = hash_table_find(&notification_hash_table, &imethod);
662 if (!link) {
663 /* Invalid notification. */
664 // TODO: Make sure this can't happen and turn it into assert.
665 notification_freelist_total--;
666 fibril_rmutex_unlock(&notification_mutex);
667 free(m);
668 return;
669 }
670
671 notification_t *notification =
672 hash_table_get_inst(link, notification_t, htlink);
673
674 notification_freelist_used++;
675 m->calldata = *call;
676 list_append(&m->link, &notification->msg_list);
677
678 if (!link_in_use(&notification->qlink))
679 list_append(&notification->qlink, &notification_queue);
680
681 fibril_rmutex_unlock(&notification_mutex);
682
683 fibril_semaphore_up(&notification_semaphore);
684}
685
686/**
687 * Creates a new notification structure and inserts it into the hash table.
688 *
689 * @param handler Function to call when notification is received.
690 * @param arg Argument for the handler function.
691 * @return The newly created notification structure.
692 */
693static notification_t *notification_create(async_notification_handler_t handler, void *arg)
694{
695 notification_t *notification = calloc(1, sizeof(notification_t));
696 if (!notification)
697 return NULL;
698
699 notification->handler = handler;
700 notification->arg = arg;
701
702 list_initialize(&notification->msg_list);
703
704 fid_t fib = 0;
705
706 fibril_rmutex_lock(&notification_mutex);
707
708 if (notification_avail == 0) {
709 /* Attempt to create the first handler fibril. */
710 fib = fibril_create(notification_fibril_func, NULL);
711 if (fib == 0) {
712 fibril_rmutex_unlock(&notification_mutex);
713 free(notification);
714 return NULL;
715 }
716 }
717
718 sysarg_t imethod = notification_avail;
719 notification_avail++;
720
721 notification->imethod = imethod;
722 hash_table_insert(&notification_hash_table, &notification->htlink);
723
724 fibril_rmutex_unlock(&notification_mutex);
725
726 if (imethod == 0) {
727 assert(fib);
728 fibril_add_ready(fib);
729 }
730
731 return notification;
732}
733
734/** Subscribe to IRQ notification.
735 *
736 * @param inr IRQ number.
737 * @param handler Notification handler.
738 * @param data Notification handler client data.
739 * @param ucode Top-half pseudocode handler.
740 *
741 * @param[out] handle IRQ capability handle on success.
742 *
743 * @return An error code.
744 *
745 */
746errno_t async_irq_subscribe(int inr, async_notification_handler_t handler,
747 void *data, const irq_code_t *ucode, cap_irq_handle_t *handle)
748{
749 notification_t *notification = notification_create(handler, data);
750 if (!notification)
751 return ENOMEM;
752
753 cap_irq_handle_t ihandle;
754 errno_t rc = ipc_irq_subscribe(inr, notification->imethod, ucode,
755 &ihandle);
756 if (rc == EOK && handle != NULL) {
757 *handle = ihandle;
758 }
759 return rc;
760}
761
762/** Unsubscribe from IRQ notification.
763 *
764 * @param handle IRQ capability handle.
765 *
766 * @return Zero on success or an error code.
767 *
768 */
769errno_t async_irq_unsubscribe(cap_irq_handle_t ihandle)
770{
771 // TODO: Remove entry from hash table
772 // to avoid memory leak
773
774 return ipc_irq_unsubscribe(ihandle);
775}
776
777/** Subscribe to event notifications.
778 *
779 * @param evno Event type to subscribe.
780 * @param handler Notification handler.
781 * @param data Notification handler client data.
782 *
783 * @return Zero on success or an error code.
784 *
785 */
786errno_t async_event_subscribe(event_type_t evno,
787 async_notification_handler_t handler, void *data)
788{
789 notification_t *notification = notification_create(handler, data);
790 if (!notification)
791 return ENOMEM;
792
793 return ipc_event_subscribe(evno, notification->imethod);
794}
795
796/** Subscribe to task event notifications.
797 *
798 * @param evno Event type to subscribe.
799 * @param handler Notification handler.
800 * @param data Notification handler client data.
801 *
802 * @return Zero on success or an error code.
803 *
804 */
805errno_t async_event_task_subscribe(event_task_type_t evno,
806 async_notification_handler_t handler, void *data)
807{
808 notification_t *notification = notification_create(handler, data);
809 if (!notification)
810 return ENOMEM;
811
812 return ipc_event_task_subscribe(evno, notification->imethod);
813}
814
815/** Unmask event notifications.
816 *
817 * @param evno Event type to unmask.
818 *
819 * @return Value returned by the kernel.
820 *
821 */
822errno_t async_event_unmask(event_type_t evno)
823{
824 return ipc_event_unmask(evno);
825}
826
827/** Unmask task event notifications.
828 *
829 * @param evno Event type to unmask.
830 *
831 * @return Value returned by the kernel.
832 *
833 */
834errno_t async_event_task_unmask(event_task_type_t evno)
835{
836 return ipc_event_task_unmask(evno);
837}
838
839/** Return new incoming message for the current (fibril-local) connection.
840 *
841 * @param call Storage where the incoming call data will be stored.
842 * @param usecs Timeout in microseconds. Zero denotes no timeout.
843 *
844 * @return If no timeout was specified, then true is returned.
845 * @return If a timeout is specified, then true is returned unless
846 * the timeout expires prior to receiving a message.
847 *
848 */
849bool async_get_call_timeout(ipc_call_t *call, usec_t usecs)
850{
851 assert(call);
852 assert(fibril_connection);
853
854 struct timespec ts;
855 struct timespec *expires = NULL;
856 if (usecs) {
857 getuptime(&ts);
858 ts_add_diff(&ts, USEC2NSEC(usecs));
859 expires = &ts;
860 }
861
862 errno_t rc = mpsc_receive(fibril_connection->msg_channel,
863 call, expires);
864
865 if (rc == ETIMEOUT)
866 return false;
867
868 if (rc != EOK) {
869 /*
870 * The async_get_call_timeout() interface doesn't support
871 * propagating errors. Return a null call instead.
872 */
873
874 memset(call, 0, sizeof(ipc_call_t));
875 ipc_set_imethod(call, IPC_M_PHONE_HUNGUP);
876 call->cap_handle = CAP_NIL;
877 }
878
879 return true;
880}
881
882bool async_get_call(ipc_call_t *call)
883{
884 return async_get_call_timeout(call, 0);
885}
886
887void *async_get_client_data(void)
888{
889 assert(fibril_connection);
890 return fibril_connection->client->data;
891}
892
893void *async_get_client_data_by_id(task_id_t client_id)
894{
895 client_t *client = async_client_get(client_id, false);
896 if (!client)
897 return NULL;
898
899 if (!client->data) {
900 async_client_put(client);
901 return NULL;
902 }
903
904 return client->data;
905}
906
907void async_put_client_data_by_id(task_id_t client_id)
908{
909 client_t *client = async_client_get(client_id, false);
910
911 assert(client);
912 assert(client->data);
913
914 /* Drop the reference we got in async_get_client_data_by_hash(). */
915 async_client_put(client);
916
917 /* Drop our own reference we got at the beginning of this function. */
918 async_client_put(client);
919}
920
921/** Handle a call that was received.
922 *
923 * If the call has the IPC_M_CONNECT_ME_TO method, a new connection is created.
924 * Otherwise the call is routed to its connection fibril.
925 *
926 * @param call Data of the incoming call.
927 *
928 */
929static void handle_call(ipc_call_t *call)
930{
931 assert(call);
932
933 if (call->flags & IPC_CALL_ANSWERED) {
934 /* Answer to a call made by us. */
935 async_reply_received(call);
936 return;
937 }
938
939 if (call->cap_handle == CAP_NIL) {
940 if (call->flags & IPC_CALL_NOTIF) {
941 /* Kernel notification */
942 queue_notification(call);
943 }
944 return;
945 }
946
947 /* New connection */
948 if (ipc_get_imethod(call) == IPC_M_CONNECT_ME_TO) {
949 connection_t *conn = calloc(1, sizeof(*conn));
950 if (!conn) {
951 ipc_answer_0(call->cap_handle, ENOMEM);
952 return;
953 }
954
955 iface_t iface = (iface_t) ipc_get_arg1(call);
956
957 // TODO: Currently ignores all ports but the first one.
958 void *data;
959 async_port_handler_t handler =
960 async_get_port_handler(iface, 0, &data);
961
962 async_new_connection(conn, call->task_id, call, handler, data);
963 return;
964 }
965
966 /* Route the call according to its request label */
967 errno_t rc = route_call(call);
968 if (rc == EOK) {
969 return;
970 } else if (implicit_connection != NULL) {
971 async_new_connection(call->in_task_id, call->in_phone_hash,
972 callid, call, implicit_connection, NULL);
973 return;
974 }
975
976 // TODO: Log the error.
977
978 if (call->cap_handle != CAP_NIL)
979 /* Unknown call from unknown phone - hang it up */
980 ipc_answer_0(call->cap_handle, EHANGUP);
981}
982
983/** Endless loop dispatching incoming calls and answers.
984 *
985 * @return Never returns.
986 *
987 */
988static errno_t async_manager_worker(void)
989{
990 ipc_call_t call;
991 errno_t rc;
992
993 while (true) {
994 rc = fibril_ipc_wait(&call, NULL);
995 if (rc == EOK)
996 handle_call(&call);
997 }
998
999 return 0;
1000}
1001
1002/** Function to start async_manager as a standalone fibril.
1003 *
1004 * When more kernel threads are used, one async manager should exist per thread.
1005 *
1006 * @param arg Unused.
1007 * @return Never returns.
1008 *
1009 */
1010static errno_t async_manager_fibril(void *arg)
1011{
1012 async_manager_worker();
1013 return 0;
1014}
1015
1016/** Add one manager to manager list. */
1017static fid_t async_create_manager(void)
1018{
1019 fid_t fid = fibril_create_generic(async_manager_fibril, NULL, PAGE_SIZE);
1020 fibril_start(fid);
1021 return fid;
1022}
1023
1024/** Initialize the async framework.
1025 *
1026 */
1027void __async_server_init(void)
1028{
1029 if (fibril_rmutex_initialize(&client_mutex) != EOK)
1030 abort();
1031 if (fibril_rmutex_initialize(&notification_mutex) != EOK)
1032 abort();
1033
1034 if (!hash_table_create(&client_hash_table, 0, 0, &client_hash_table_ops))
1035 abort();
1036
1037 if (!hash_table_create(&notification_hash_table, 0, 0,
1038 &notification_hash_table_ops))
1039 abort();
1040
1041 async_create_manager();
1042}
1043
1044void __async_server_fini(void)
1045{
1046 fibril_rmutex_destroy(&client_mutex);
1047 fibril_rmutex_destroy(&notification_mutex);
1048}
1049
1050errno_t async_accept_0(ipc_call_t *call)
1051{
1052 cap_call_handle_t chandle = call->cap_handle;
1053 assert(chandle != CAP_NIL);
1054 call->cap_handle = CAP_NIL;
1055 return ipc_answer_5(chandle, EOK, 0, 0, 0, 0, async_get_label());
1056}
1057
1058errno_t async_answer_0(ipc_call_t *call, errno_t retval)
1059{
1060 cap_call_handle_t chandle = call->cap_handle;
1061 assert(chandle != CAP_NIL);
1062 call->cap_handle = CAP_NIL;
1063 return ipc_answer_0(chandle, retval);
1064}
1065
1066errno_t async_answer_1(ipc_call_t *call, errno_t retval, sysarg_t arg1)
1067{
1068 cap_call_handle_t chandle = call->cap_handle;
1069 assert(chandle != CAP_NIL);
1070 call->cap_handle = CAP_NIL;
1071 return ipc_answer_1(chandle, retval, arg1);
1072}
1073
1074errno_t async_answer_2(ipc_call_t *call, errno_t retval, sysarg_t arg1,
1075 sysarg_t arg2)
1076{
1077 cap_call_handle_t chandle = call->cap_handle;
1078 assert(chandle != CAP_NIL);
1079 call->cap_handle = CAP_NIL;
1080 return ipc_answer_2(chandle, retval, arg1, arg2);
1081}
1082
1083errno_t async_answer_3(ipc_call_t *call, errno_t retval, sysarg_t arg1,
1084 sysarg_t arg2, sysarg_t arg3)
1085{
1086 cap_call_handle_t chandle = call->cap_handle;
1087 assert(chandle != CAP_NIL);
1088 call->cap_handle = CAP_NIL;
1089 return ipc_answer_3(chandle, retval, arg1, arg2, arg3);
1090}
1091
1092errno_t async_answer_4(ipc_call_t *call, errno_t retval, sysarg_t arg1,
1093 sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
1094{
1095 cap_call_handle_t chandle = call->cap_handle;
1096 assert(chandle != CAP_NIL);
1097 call->cap_handle = CAP_NIL;
1098 return ipc_answer_4(chandle, retval, arg1, arg2, arg3, arg4);
1099}
1100
1101errno_t async_answer_5(ipc_call_t *call, errno_t retval, sysarg_t arg1,
1102 sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5)
1103{
1104 cap_call_handle_t chandle = call->cap_handle;
1105 assert(chandle != CAP_NIL);
1106 call->cap_handle = CAP_NIL;
1107 return ipc_answer_5(chandle, retval, arg1, arg2, arg3, arg4, arg5);
1108}
1109
1110static errno_t async_forward_fast(ipc_call_t *call, async_exch_t *exch,
1111 sysarg_t imethod, sysarg_t arg1, sysarg_t arg2, unsigned int mode)
1112{
1113 assert(call);
1114
1115 cap_call_handle_t chandle = call->cap_handle;
1116 assert(chandle != CAP_NIL);
1117 call->cap_handle = CAP_NIL;
1118
1119 if (exch == NULL)
1120 return ENOENT;
1121
1122 return ipc_forward_fast(chandle, exch->phone, imethod, arg1, arg2,
1123 mode);
1124}
1125
1126static errno_t async_forward_slow(ipc_call_t *call, async_exch_t *exch,
1127 sysarg_t imethod, sysarg_t arg1, sysarg_t arg2, sysarg_t arg3,
1128 sysarg_t arg4, sysarg_t arg5, unsigned int mode)
1129{
1130 assert(call);
1131
1132 cap_call_handle_t chandle = call->cap_handle;
1133 assert(chandle != CAP_NIL);
1134 call->cap_handle = CAP_NIL;
1135
1136 if (exch == NULL)
1137 return ENOENT;
1138
1139 return ipc_forward_slow(chandle, exch->phone, imethod, arg1, arg2, arg3,
1140 arg4, arg5, mode);
1141}
1142
1143errno_t async_forward_0(ipc_call_t *call, async_exch_t *exch, sysarg_t imethod,
1144 unsigned int mode)
1145{
1146 return async_forward_fast(call, exch, imethod, 0, 0, mode);
1147}
1148
1149errno_t async_forward_1(ipc_call_t *call, async_exch_t *exch, sysarg_t imethod,
1150 sysarg_t arg1, unsigned int mode)
1151{
1152 return async_forward_fast(call, exch, imethod, arg1, 0, mode);
1153}
1154
1155errno_t async_forward_2(ipc_call_t *call, async_exch_t *exch, sysarg_t imethod,
1156 sysarg_t arg1, sysarg_t arg2, unsigned int mode)
1157{
1158 return async_forward_fast(call, exch, imethod, arg1, arg2, mode);
1159}
1160
1161errno_t async_forward_3(ipc_call_t *call, async_exch_t *exch, sysarg_t imethod,
1162 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, unsigned int mode)
1163{
1164 return async_forward_slow(call, exch, imethod, arg1, arg2, arg3, 0, 0,
1165 mode);
1166}
1167
1168errno_t async_forward_4(ipc_call_t *call, async_exch_t *exch, sysarg_t imethod,
1169 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4,
1170 unsigned int mode)
1171{
1172 return async_forward_slow(call, exch, imethod, arg1, arg2, arg3, arg4,
1173 0, mode);
1174}
1175
1176errno_t async_forward_5(ipc_call_t *call, async_exch_t *exch, sysarg_t imethod,
1177 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5,
1178 unsigned int mode)
1179{
1180 return async_forward_slow(call, exch, imethod, arg1, arg2, arg3, arg4,
1181 arg5, mode);
1182}
1183
1184/** Wrapper for making IPC_M_CONNECT_TO_ME calls using the async framework.
1185 *
1186 * Ask through phone for a new connection to some service.
1187 *
1188 * @param exch Exchange for sending the message.
1189 * @param iface Callback interface.
1190 * @param arg2 User defined argument.
1191 * @param arg3 User defined argument.
1192 *
1193 * @return Zero on success or an error code.
1194 *
1195 */
1196errno_t async_connect_to_me(async_exch_t *exch, iface_t iface, sysarg_t arg2,
1197 sysarg_t arg3)
1198{
1199 if (exch == NULL)
1200 return ENOENT;
1201
1202 sysarg_t label = 0;
1203 errno_t rc = async_req_5_0(exch, IPC_M_CONNECT_TO_ME, iface, arg2, arg3,
1204 0, label);
1205
1206 return rc;
1207}
1208
1209/** Wrapper for receiving the IPC_M_SHARE_IN calls using the async framework.
1210 *
1211 * This wrapper only makes it more comfortable to receive IPC_M_SHARE_IN
1212 * calls so that the user doesn't have to remember the meaning of each IPC
1213 * argument.
1214 *
1215 * So far, this wrapper is to be used from within a connection fibril.
1216 *
1217 * @param call Storage for the data of the IPC_M_SHARE_IN call.
1218 * @param size Destination address space area size.
1219 *
1220 * @return True on success, false on failure.
1221 *
1222 */
1223bool async_share_in_receive(ipc_call_t *call, size_t *size)
1224{
1225 assert(call);
1226 assert(size);
1227
1228 async_get_call(call);
1229
1230 if (ipc_get_imethod(call) != IPC_M_SHARE_IN)
1231 return false;
1232
1233 *size = (size_t) ipc_get_arg1(call);
1234 return true;
1235}
1236
1237/** Wrapper for answering the IPC_M_SHARE_IN calls using the async framework.
1238 *
1239 * This wrapper only makes it more comfortable to answer IPC_M_SHARE_IN
1240 * calls so that the user doesn't have to remember the meaning of each IPC
1241 * argument.
1242 *
1243 * @param call IPC_M_SHARE_IN call to answer.
1244 * @param src Source address space base.
1245 * @param flags Flags to be used for sharing. Bits can be only cleared.
1246 *
1247 * @return Zero on success or a value from @ref errno.h on failure.
1248 *
1249 */
1250errno_t async_share_in_finalize(ipc_call_t *call, void *src, unsigned int flags)
1251{
1252 assert(call);
1253
1254 cap_call_handle_t chandle = call->cap_handle;
1255 assert(chandle != CAP_NIL);
1256 call->cap_handle = CAP_NIL;
1257
1258 return ipc_answer_2(chandle, EOK, (sysarg_t) src, (sysarg_t) flags);
1259}
1260
1261/** Wrapper for receiving the IPC_M_SHARE_OUT calls using the async framework.
1262 *
1263 * This wrapper only makes it more comfortable to receive IPC_M_SHARE_OUT
1264 * calls so that the user doesn't have to remember the meaning of each IPC
1265 * argument.
1266 *
1267 * So far, this wrapper is to be used from within a connection fibril.
1268 *
1269 * @param call Storage for the data of the IPC_M_SHARE_OUT call.
1270 * @param size Storage for the source address space area size.
1271 * @param flags Storage for the sharing flags.
1272 *
1273 * @return True on success, false on failure.
1274 *
1275 */
1276bool async_share_out_receive(ipc_call_t *call, size_t *size,
1277 unsigned int *flags)
1278{
1279 assert(call);
1280 assert(size);
1281 assert(flags);
1282
1283 async_get_call(call);
1284
1285 if (ipc_get_imethod(call) != IPC_M_SHARE_OUT)
1286 return false;
1287
1288 *size = (size_t) ipc_get_arg2(call);
1289 *flags = (unsigned int) ipc_get_arg3(call);
1290 return true;
1291}
1292
1293/** Wrapper for answering the IPC_M_SHARE_OUT calls using the async framework.
1294 *
1295 * This wrapper only makes it more comfortable to answer IPC_M_SHARE_OUT
1296 * calls so that the user doesn't have to remember the meaning of each IPC
1297 * argument.
1298 *
1299 * @param call IPC_M_SHARE_OUT call to answer.
1300 * @param dst Address of the storage for the destination address space area
1301 * base address.
1302 *
1303 * @return Zero on success or a value from @ref errno.h on failure.
1304 *
1305 */
1306errno_t async_share_out_finalize(ipc_call_t *call, void **dst)
1307{
1308 assert(call);
1309
1310 cap_call_handle_t chandle = call->cap_handle;
1311 assert(chandle != CAP_NIL);
1312 call->cap_handle = CAP_NIL;
1313
1314 return ipc_answer_2(chandle, EOK, (sysarg_t) __progsymbols.end,
1315 (sysarg_t) dst);
1316}
1317
1318/** Wrapper for receiving the IPC_M_DATA_READ calls using the async framework.
1319 *
1320 * This wrapper only makes it more comfortable to receive IPC_M_DATA_READ
1321 * calls so that the user doesn't have to remember the meaning of each IPC
1322 * argument.
1323 *
1324 * So far, this wrapper is to be used from within a connection fibril.
1325 *
1326 * @param call Storage for the data of the IPC_M_DATA_READ.
1327 * @param size Storage for the maximum size. Can be NULL.
1328 *
1329 * @return True on success, false on failure.
1330 *
1331 */
1332bool async_data_read_receive(ipc_call_t *call, size_t *size)
1333{
1334 assert(call);
1335
1336 async_get_call(call);
1337
1338 if (ipc_get_imethod(call) != IPC_M_DATA_READ)
1339 return false;
1340
1341 if (size)
1342 *size = (size_t) ipc_get_arg2(call);
1343
1344 return true;
1345}
1346
1347/** Wrapper for answering the IPC_M_DATA_READ calls using the async framework.
1348 *
1349 * This wrapper only makes it more comfortable to answer IPC_M_DATA_READ
1350 * calls so that the user doesn't have to remember the meaning of each IPC
1351 * argument.
1352 *
1353 * @param call IPC_M_DATA_READ call to answer.
1354 * @param src Source address for the IPC_M_DATA_READ call.
1355 * @param size Size for the IPC_M_DATA_READ call. Can be smaller than
1356 * the maximum size announced by the sender.
1357 *
1358 * @return Zero on success or a value from @ref errno.h on failure.
1359 *
1360 */
1361errno_t async_data_read_finalize(ipc_call_t *call, const void *src, size_t size)
1362{
1363 assert(call);
1364
1365 cap_call_handle_t chandle = call->cap_handle;
1366 assert(chandle != CAP_NIL);
1367 call->cap_handle = CAP_NIL;
1368
1369 return ipc_answer_2(chandle, EOK, (sysarg_t) src, (sysarg_t) size);
1370}
1371
1372/** Wrapper for forwarding any read request
1373 *
1374 */
1375static errno_t async_data_read_forward_fast(async_exch_t *exch, sysarg_t imethod,
1376 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4,
1377 ipc_call_t *dataptr)
1378{
1379 if (exch == NULL)
1380 return ENOENT;
1381
1382 ipc_call_t call;
1383 if (!async_data_read_receive(&call, NULL)) {
1384 async_answer_0(&call, EINVAL);
1385 return EINVAL;
1386 }
1387
1388 aid_t msg = async_send_4(exch, imethod, arg1, arg2, arg3, arg4,
1389 dataptr);
1390 if (msg == 0) {
1391 async_answer_0(&call, EINVAL);
1392 return EINVAL;
1393 }
1394
1395 errno_t retval = ipc_forward_fast(call.cap_handle, exch->phone, 0, 0, 0,
1396 IPC_FF_ROUTE_FROM_ME);
1397 if (retval != EOK) {
1398 async_forget(msg);
1399 async_answer_0(&call, retval);
1400 return retval;
1401 }
1402
1403 errno_t rc;
1404 async_wait_for(msg, &rc);
1405
1406 return (errno_t) rc;
1407}
1408
1409errno_t async_data_read_forward_0_0(async_exch_t *exch, sysarg_t imethod)
1410{
1411 return async_data_read_forward_fast(exch, imethod, 0, 0, 0, 0, NULL);
1412}
1413
1414errno_t async_data_read_forward_1_0(async_exch_t *exch, sysarg_t imethod,
1415 sysarg_t arg1)
1416{
1417 return async_data_read_forward_fast(exch, imethod, arg1, 0, 0, 0, NULL);
1418}
1419
1420errno_t async_data_read_forward_2_0(async_exch_t *exch, sysarg_t imethod,
1421 sysarg_t arg1, sysarg_t arg2)
1422{
1423 return async_data_read_forward_fast(exch, imethod, arg1, arg2, 0,
1424 0, NULL);
1425}
1426
1427errno_t async_data_read_forward_3_0(async_exch_t *exch, sysarg_t imethod,
1428 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3)
1429{
1430 return async_data_read_forward_fast(exch, imethod, arg1, arg2, arg3,
1431 0, NULL);
1432}
1433
1434errno_t async_data_read_forward_4_0(async_exch_t *exch, sysarg_t imethod,
1435 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
1436{
1437 return async_data_read_forward_fast(exch, imethod, arg1, arg2, arg3,
1438 arg4, NULL);
1439}
1440
1441errno_t async_data_read_forward_0_1(async_exch_t *exch, sysarg_t imethod,
1442 ipc_call_t *dataptr)
1443{
1444 return async_data_read_forward_fast(exch, imethod, 0, 0, 0,
1445 0, dataptr);
1446}
1447
1448errno_t async_data_read_forward_1_1(async_exch_t *exch, sysarg_t imethod,
1449 sysarg_t arg1, ipc_call_t *dataptr)
1450{
1451 return async_data_read_forward_fast(exch, imethod, arg1, 0, 0,
1452 0, dataptr);
1453}
1454
1455errno_t async_data_read_forward_2_1(async_exch_t *exch, sysarg_t imethod,
1456 sysarg_t arg1, sysarg_t arg2, ipc_call_t *dataptr)
1457{
1458 return async_data_read_forward_fast(exch, imethod, arg1, arg2, 0,
1459 0, dataptr);
1460}
1461
1462errno_t async_data_read_forward_3_1(async_exch_t *exch, sysarg_t imethod,
1463 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, ipc_call_t *dataptr)
1464{
1465 return async_data_read_forward_fast(exch, imethod, arg1, arg2, arg3,
1466 0, dataptr);
1467}
1468
1469errno_t async_data_read_forward_4_1(async_exch_t *exch, sysarg_t imethod,
1470 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4,
1471 ipc_call_t *dataptr)
1472{
1473 return async_data_read_forward_fast(exch, imethod, arg1, arg2, arg3,
1474 arg4, dataptr);
1475}
1476
1477/** Wrapper for receiving the IPC_M_DATA_WRITE calls using the async framework.
1478 *
1479 * This wrapper only makes it more comfortable to receive IPC_M_DATA_WRITE
1480 * calls so that the user doesn't have to remember the meaning of each IPC
1481 * argument.
1482 *
1483 * So far, this wrapper is to be used from within a connection fibril.
1484 *
1485 * @param call Storage for the data of the IPC_M_DATA_WRITE.
1486 * @param size Storage for the suggested size. May be NULL.
1487 *
1488 * @return True on success, false on failure.
1489 *
1490 */
1491bool async_data_write_receive(ipc_call_t *call, size_t *size)
1492{
1493 assert(call);
1494
1495 async_get_call(call);
1496
1497 if (ipc_get_imethod(call) != IPC_M_DATA_WRITE)
1498 return false;
1499
1500 if (size)
1501 *size = (size_t) ipc_get_arg2(call);
1502
1503 return true;
1504}
1505
1506/** Wrapper for answering the IPC_M_DATA_WRITE calls using the async framework.
1507 *
1508 * This wrapper only makes it more comfortable to answer IPC_M_DATA_WRITE
1509 * calls so that the user doesn't have to remember the meaning of each IPC
1510 * argument.
1511 *
1512 * @param call IPC_M_DATA_WRITE call to answer.
1513 * @param dst Final destination address for the IPC_M_DATA_WRITE call.
1514 * @param size Final size for the IPC_M_DATA_WRITE call.
1515 *
1516 * @return Zero on success or a value from @ref errno.h on failure.
1517 *
1518 */
1519errno_t async_data_write_finalize(ipc_call_t *call, void *dst, size_t size)
1520{
1521 assert(call);
1522
1523 return async_answer_2(call, EOK, (sysarg_t) dst, (sysarg_t) size);
1524}
1525
1526/** Wrapper for receiving binary data or strings
1527 *
1528 * This wrapper only makes it more comfortable to use async_data_write_*
1529 * functions to receive binary data or strings.
1530 *
1531 * @param data Pointer to data pointer (which should be later disposed
1532 * by free()). If the operation fails, the pointer is not
1533 * touched.
1534 * @param nullterm If true then the received data is always zero terminated.
1535 * This also causes to allocate one extra byte beyond the
1536 * raw transmitted data.
1537 * @param min_size Minimum size (in bytes) of the data to receive.
1538 * @param max_size Maximum size (in bytes) of the data to receive. 0 means
1539 * no limit.
1540 * @param granulariy If non-zero then the size of the received data has to
1541 * be divisible by this value.
1542 * @param received If not NULL, the size of the received data is stored here.
1543 *
1544 * @return Zero on success or a value from @ref errno.h on failure.
1545 *
1546 */
1547errno_t async_data_write_accept(void **data, const bool nullterm,
1548 const size_t min_size, const size_t max_size, const size_t granularity,
1549 size_t *received)
1550{
1551 assert(data);
1552
1553 ipc_call_t call;
1554 size_t size;
1555 if (!async_data_write_receive(&call, &size)) {
1556 async_answer_0(&call, EINVAL);
1557 return EINVAL;
1558 }
1559
1560 if (size < min_size) {
1561 async_answer_0(&call, EINVAL);
1562 return EINVAL;
1563 }
1564
1565 if ((max_size > 0) && (size > max_size)) {
1566 async_answer_0(&call, EINVAL);
1567 return EINVAL;
1568 }
1569
1570 if ((granularity > 0) && ((size % granularity) != 0)) {
1571 async_answer_0(&call, EINVAL);
1572 return EINVAL;
1573 }
1574
1575 void *arg_data;
1576
1577 if (nullterm)
1578 arg_data = malloc(size + 1);
1579 else
1580 arg_data = malloc(size);
1581
1582 if (arg_data == NULL) {
1583 async_answer_0(&call, ENOMEM);
1584 return ENOMEM;
1585 }
1586
1587 errno_t rc = async_data_write_finalize(&call, arg_data, size);
1588 if (rc != EOK) {
1589 free(arg_data);
1590 return rc;
1591 }
1592
1593 if (nullterm)
1594 ((char *) arg_data)[size] = 0;
1595
1596 *data = arg_data;
1597 if (received != NULL)
1598 *received = size;
1599
1600 return EOK;
1601}
1602
1603/** Wrapper for voiding any data that is about to be received
1604 *
1605 * This wrapper can be used to void any pending data
1606 *
1607 * @param retval Error value from @ref errno.h to be returned to the caller.
1608 *
1609 */
1610void async_data_write_void(errno_t retval)
1611{
1612 ipc_call_t call;
1613 async_data_write_receive(&call, NULL);
1614 async_answer_0(&call, retval);
1615}
1616
1617/** Wrapper for forwarding any data that is about to be received
1618 *
1619 */
1620static errno_t async_data_write_forward_fast(async_exch_t *exch,
1621 sysarg_t imethod, sysarg_t arg1, sysarg_t arg2, sysarg_t arg3,
1622 sysarg_t arg4, ipc_call_t *dataptr)
1623{
1624 if (exch == NULL)
1625 return ENOENT;
1626
1627 ipc_call_t call;
1628 if (!async_data_write_receive(&call, NULL)) {
1629 async_answer_0(&call, EINVAL);
1630 return EINVAL;
1631 }
1632
1633 aid_t msg = async_send_4(exch, imethod, arg1, arg2, arg3, arg4,
1634 dataptr);
1635 if (msg == 0) {
1636 async_answer_0(&call, EINVAL);
1637 return EINVAL;
1638 }
1639
1640 errno_t retval = ipc_forward_fast(call.cap_handle, exch->phone, 0, 0, 0,
1641 IPC_FF_ROUTE_FROM_ME);
1642 if (retval != EOK) {
1643 async_forget(msg);
1644 async_answer_0(&call, retval);
1645 return retval;
1646 }
1647
1648 errno_t rc;
1649 async_wait_for(msg, &rc);
1650
1651 return (errno_t) rc;
1652}
1653
1654errno_t async_data_write_forward_0_0(async_exch_t *exch, sysarg_t imethod)
1655{
1656 return async_data_write_forward_fast(exch, imethod, 0, 0, 0,
1657 0, NULL);
1658}
1659
1660errno_t async_data_write_forward_1_0(async_exch_t *exch, sysarg_t imethod,
1661 sysarg_t arg1)
1662{
1663 return async_data_write_forward_fast(exch, imethod, arg1, 0, 0,
1664 0, NULL);
1665}
1666
1667errno_t async_data_write_forward_2_0(async_exch_t *exch, sysarg_t imethod,
1668 sysarg_t arg1, sysarg_t arg2)
1669{
1670 return async_data_write_forward_fast(exch, imethod, arg1, arg2, 0,
1671 0, NULL);
1672}
1673
1674errno_t async_data_write_forward_3_0(async_exch_t *exch, sysarg_t imethod,
1675 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3)
1676{
1677 return async_data_write_forward_fast(exch, imethod, arg1, arg2, arg3,
1678 0, NULL);
1679}
1680
1681errno_t async_data_write_forward_4_0(async_exch_t *exch, sysarg_t imethod,
1682 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4)
1683{
1684 return async_data_write_forward_fast(exch, imethod, arg1, arg2, arg3,
1685 arg4, NULL);
1686}
1687
1688errno_t async_data_write_forward_0_1(async_exch_t *exch, sysarg_t imethod,
1689 ipc_call_t *dataptr)
1690{
1691 return async_data_write_forward_fast(exch, imethod, 0, 0, 0,
1692 0, dataptr);
1693}
1694
1695errno_t async_data_write_forward_1_1(async_exch_t *exch, sysarg_t imethod,
1696 sysarg_t arg1, ipc_call_t *dataptr)
1697{
1698 return async_data_write_forward_fast(exch, imethod, arg1, 0, 0,
1699 0, dataptr);
1700}
1701
1702errno_t async_data_write_forward_2_1(async_exch_t *exch, sysarg_t imethod,
1703 sysarg_t arg1, sysarg_t arg2, ipc_call_t *dataptr)
1704{
1705 return async_data_write_forward_fast(exch, imethod, arg1, arg2, 0,
1706 0, dataptr);
1707}
1708
1709errno_t async_data_write_forward_3_1(async_exch_t *exch, sysarg_t imethod,
1710 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, ipc_call_t *dataptr)
1711{
1712 return async_data_write_forward_fast(exch, imethod, arg1, arg2, arg3,
1713 0, dataptr);
1714}
1715
1716errno_t async_data_write_forward_4_1(async_exch_t *exch, sysarg_t imethod,
1717 sysarg_t arg1, sysarg_t arg2, sysarg_t arg3, sysarg_t arg4,
1718 ipc_call_t *dataptr)
1719{
1720 return async_data_write_forward_fast(exch, imethod, arg1, arg2, arg3,
1721 arg4, dataptr);
1722}
1723
1724/** Wrapper for receiving the IPC_M_CONNECT_TO_ME calls.
1725 *
1726 * If the current call is IPC_M_CONNECT_TO_ME then a new
1727 * async session is created for the accepted phone.
1728 *
1729 * @param mgmt Exchange management style.
1730 *
1731 * @return New async session.
1732 * @return NULL on failure.
1733 *
1734 */
1735async_sess_t *async_callback_receive(exch_mgmt_t mgmt)
1736{
1737 /* Accept the phone */
1738 ipc_call_t call;
1739 async_get_call(&call);
1740
1741 cap_phone_handle_t phandle = (cap_handle_t) ipc_get_arg5(&call);
1742
1743 if ((ipc_get_imethod(&call) != IPC_M_CONNECT_TO_ME) ||
1744 !cap_handle_valid((phandle))) {
1745 async_answer_0(&call, EINVAL);
1746 return NULL;
1747 }
1748
1749 async_sess_t *sess = create_session(phandle, mgmt, 0, 0, 0);
1750 if (sess == NULL) {
1751 ipc_hangup(phone);
1752 async_answer_0(&call, errno);
1753 } else {
1754 /* Acknowledge the connected phone */
1755 async_answer_0(&call, EOK);
1756 }
1757
1758 return sess;
1759}
1760
1761/** Wrapper for receiving the IPC_M_CONNECT_TO_ME calls.
1762 *
1763 * If the call is IPC_M_CONNECT_TO_ME then a new
1764 * async session is created. However, the phone is
1765 * not accepted automatically.
1766 *
1767 * @param mgmt Exchange management style.
1768 * @param call Call data.
1769 *
1770 * @return New async session.
1771 * @return NULL on failure.
1772 * @return NULL if the call is not IPC_M_CONNECT_TO_ME.
1773 *
1774 */
1775async_sess_t *async_callback_receive_start(exch_mgmt_t mgmt, ipc_call_t *call)
1776{
1777 cap_phone_handle_t phandle = (cap_handle_t) ipc_get_arg5(call);
1778
1779 if ((ipc_get_imethod(call) != IPC_M_CONNECT_TO_ME) ||
1780 !cap_handle_valid((phandle)))
1781 return NULL;
1782
1783 return create_session(phandle, mgmt, 0, 0, 0);
1784}
1785
1786bool async_state_change_receive(ipc_call_t *call)
1787{
1788 assert(call);
1789
1790 async_get_call(call);
1791
1792 if (ipc_get_imethod(call) != IPC_M_STATE_CHANGE_AUTHORIZE)
1793 return false;
1794
1795 return true;
1796}
1797
1798errno_t async_state_change_finalize(ipc_call_t *call, async_exch_t *other_exch)
1799{
1800 assert(call);
1801
1802 return async_answer_1(call, EOK, cap_handle_raw(other_exch->phone));
1803}
1804
1805__noreturn void async_manager(void)
1806{
1807 fibril_event_t ever = FIBRIL_EVENT_INIT;
1808 fibril_wait_for(&ever);
1809 __builtin_unreachable();
1810}
1811
1812/** @}
1813 */
Note: See TracBrowser for help on using the repository browser.