source: mainline/uspace/lib/c/include/async.h@ cb20b05

Last change on this file since cb20b05 was ca48672, checked in by Jiri Svoboda <jiri@…>, 8 days ago

loc_service_register() needs to take a port ID argument.

  • Property mode set to 100644
File size: 16.2 KB
Line 
1/*
2 * Copyright (c) 2025 Jiri Svoboda
3 * Copyright (c) 2006 Ondrej Palkovsky
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup libc
31 * @{
32 */
33/** @file
34 */
35
36#if ((defined(_LIBC_IPC_H_)) && (!defined(_LIBC_ASYNC_C_)))
37#error Do not intermix low-level IPC interface and async framework
38#endif
39
40#ifndef _LIBC_ASYNC_H_
41#define _LIBC_ASYNC_H_
42
43#include <ipc/common.h>
44#include <time.h>
45#include <stdbool.h>
46#include <abi/proc/task.h>
47#include <abi/ddi/irq.h>
48#include <abi/ipc/event.h>
49#include <abi/ipc/interfaces.h>
50#include <abi/cap.h>
51
52#include <_bits/__noreturn.h>
53
54typedef sysarg_t aid_t;
55typedef sysarg_t port_id_t;
56
57typedef void *(*async_client_data_ctor_t)(void);
58typedef void (*async_client_data_dtor_t)(void *);
59
60/** Port connection handler
61 *
62 * @param call Incoming call or NULL if connection initiated from inside
63 * using async_create_callback_port()
64 * @param arg Local argument.
65 *
66 */
67typedef void (*async_port_handler_t)(ipc_call_t *, void *);
68
69/** Notification handler */
70typedef void (*async_notification_handler_t)(ipc_call_t *, void *);
71
72/** Exchange management style
73 *
74 */
75typedef enum {
76 /** No explicit exchange management
77 *
78 * Suitable for protocols which use a single
79 * IPC message per exchange only.
80 *
81 */
82 EXCHANGE_ATOMIC = 0,
83
84 /** Exchange management via mutual exclusion
85 *
86 * Suitable for any kind of client/server communication,
87 * but can limit parallelism.
88 *
89 */
90 EXCHANGE_SERIALIZE = 1,
91
92 /** Exchange management via phone cloning
93 *
94 * Suitable for servers which support client
95 * data tracking by task hashes and do not
96 * mind cloned phones.
97 *
98 */
99 EXCHANGE_PARALLEL = 2
100} exch_mgmt_t;
101
102enum {
103 fallback_port_id = 0
104};
105
106/** Forward declarations */
107struct async_exch;
108struct async_sess;
109
110typedef struct async_sess async_sess_t;
111typedef struct async_exch async_exch_t;
112
113extern __noreturn void async_manager(void);
114
115extern bool async_get_call(ipc_call_t *);
116extern bool async_get_call_timeout(ipc_call_t *, usec_t);
117
118extern aid_t async_send_0(async_exch_t *, sysarg_t, ipc_call_t *);
119extern aid_t async_send_1(async_exch_t *, sysarg_t, sysarg_t, ipc_call_t *);
120extern aid_t async_send_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
121 ipc_call_t *);
122extern aid_t async_send_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
123 sysarg_t, ipc_call_t *);
124extern aid_t async_send_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
125 sysarg_t, sysarg_t, ipc_call_t *);
126extern aid_t async_send_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
127 sysarg_t, sysarg_t, sysarg_t, ipc_call_t *);
128
129extern void async_wait_for(aid_t, errno_t *);
130extern errno_t async_wait_timeout(aid_t, errno_t *, usec_t);
131extern void async_forget(aid_t);
132
133extern void async_set_client_data_constructor(async_client_data_ctor_t);
134extern void async_set_client_data_destructor(async_client_data_dtor_t);
135extern void *async_get_client_data(void);
136extern void *async_get_client_data_by_id(task_id_t);
137extern void async_put_client_data_by_id(task_id_t);
138
139extern errno_t async_create_port(iface_t, async_port_handler_t, void *,
140 port_id_t *);
141extern void async_port_destroy(port_id_t);
142extern errno_t async_port_create_interface(port_id_t, iface_t,
143 async_port_handler_t, void *);
144extern void async_set_fallback_port_handler(async_port_handler_t, void *);
145extern errno_t async_create_callback_port(async_exch_t *, iface_t, sysarg_t,
146 sysarg_t, async_port_handler_t, void *, port_id_t *);
147
148extern errno_t async_irq_subscribe(int, async_notification_handler_t, void *,
149 const irq_code_t *, cap_irq_handle_t *);
150extern errno_t async_irq_unsubscribe(cap_irq_handle_t);
151
152extern errno_t async_event_subscribe(event_type_t, async_notification_handler_t,
153 void *);
154extern errno_t async_event_task_subscribe(event_task_type_t,
155 async_notification_handler_t, void *);
156extern errno_t async_event_unsubscribe(event_type_t);
157extern errno_t async_event_task_unsubscribe(event_task_type_t);
158extern errno_t async_event_unmask(event_type_t);
159extern errno_t async_event_task_unmask(event_task_type_t);
160
161/*
162 * Wrappers for simple communication.
163 */
164
165extern void async_msg_0(async_exch_t *, sysarg_t);
166extern void async_msg_1(async_exch_t *, sysarg_t, sysarg_t);
167extern void async_msg_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t);
168extern void async_msg_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t, sysarg_t);
169extern void async_msg_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
170 sysarg_t);
171extern void async_msg_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
172 sysarg_t, sysarg_t);
173
174/*
175 * Wrappers for answer routines.
176 */
177
178extern errno_t async_answer_0(ipc_call_t *, errno_t);
179extern errno_t async_answer_1(ipc_call_t *, errno_t, sysarg_t);
180extern errno_t async_answer_2(ipc_call_t *, errno_t, sysarg_t, sysarg_t);
181extern errno_t async_answer_3(ipc_call_t *, errno_t, sysarg_t, sysarg_t,
182 sysarg_t);
183extern errno_t async_answer_4(ipc_call_t *, errno_t, sysarg_t, sysarg_t,
184 sysarg_t, sysarg_t);
185extern errno_t async_answer_5(ipc_call_t *, errno_t, sysarg_t, sysarg_t,
186 sysarg_t, sysarg_t, sysarg_t);
187
188/*
189 * Wrappers for forwarding routines.
190 */
191
192extern errno_t async_forward_0(ipc_call_t *, async_exch_t *, sysarg_t,
193 unsigned int);
194extern errno_t async_forward_1(ipc_call_t *, async_exch_t *, sysarg_t,
195 sysarg_t, unsigned int);
196extern errno_t async_forward_2(ipc_call_t *, async_exch_t *, sysarg_t,
197 sysarg_t, sysarg_t, unsigned int);
198extern errno_t async_forward_3(ipc_call_t *, async_exch_t *, sysarg_t,
199 sysarg_t, sysarg_t, sysarg_t, unsigned int);
200extern errno_t async_forward_4(ipc_call_t *, async_exch_t *, sysarg_t,
201 sysarg_t, sysarg_t, sysarg_t, sysarg_t, unsigned int);
202extern errno_t async_forward_5(ipc_call_t *, async_exch_t *, sysarg_t,
203 sysarg_t, sysarg_t, sysarg_t, sysarg_t, sysarg_t, unsigned int);
204
205/*
206 * User-friendly wrappers for async_req_*_*().
207 * The functions are in the form async_req_m_n(), where m is the number of
208 * payload arguments and n is the number of return arguments.
209 */
210
211extern errno_t async_req_0_0(async_exch_t *, sysarg_t);
212extern errno_t async_req_0_1(async_exch_t *, sysarg_t, sysarg_t *);
213extern errno_t async_req_0_2(async_exch_t *, sysarg_t, sysarg_t *, sysarg_t *);
214extern errno_t async_req_0_3(async_exch_t *, sysarg_t, sysarg_t *, sysarg_t *,
215 sysarg_t *);
216extern errno_t async_req_0_4(async_exch_t *, sysarg_t, sysarg_t *, sysarg_t *,
217 sysarg_t *, sysarg_t *);
218extern errno_t async_req_0_5(async_exch_t *, sysarg_t, sysarg_t *, sysarg_t *,
219 sysarg_t *, sysarg_t *, sysarg_t *);
220extern errno_t async_req_1_0(async_exch_t *, sysarg_t, sysarg_t);
221extern errno_t async_req_1_1(async_exch_t *, sysarg_t, sysarg_t, sysarg_t *);
222extern errno_t async_req_1_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t *,
223 sysarg_t *);
224extern errno_t async_req_1_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t *,
225 sysarg_t *, sysarg_t *);
226extern errno_t async_req_1_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t *,
227 sysarg_t *, sysarg_t *, sysarg_t *);
228extern errno_t async_req_1_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t *,
229 sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
230extern errno_t async_req_2_0(async_exch_t *, sysarg_t, sysarg_t, sysarg_t);
231extern errno_t async_req_2_1(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
232 sysarg_t *);
233extern errno_t async_req_2_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
234 sysarg_t *, sysarg_t *);
235extern errno_t async_req_2_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
236 sysarg_t *, sysarg_t *, sysarg_t *);
237extern errno_t async_req_2_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
238 sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
239extern errno_t async_req_2_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
240 sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
241extern errno_t async_req_3_0(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
242 sysarg_t);
243extern errno_t async_req_3_1(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
244 sysarg_t, sysarg_t *);
245extern errno_t async_req_3_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
246 sysarg_t, sysarg_t *, sysarg_t *);
247extern errno_t async_req_3_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
248 sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *);
249extern errno_t async_req_3_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
250 sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
251extern errno_t async_req_3_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
252 sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
253extern errno_t async_req_4_0(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
254 sysarg_t, sysarg_t);
255extern errno_t async_req_4_1(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
256 sysarg_t, sysarg_t, sysarg_t *);
257extern errno_t async_req_4_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
258 sysarg_t, sysarg_t, sysarg_t *, sysarg_t *);
259extern errno_t async_req_4_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
260 sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *);
261extern errno_t async_req_4_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
262 sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
263extern errno_t async_req_4_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
264 sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *,
265 sysarg_t *);
266extern errno_t async_req_5_0(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
267 sysarg_t, sysarg_t, sysarg_t);
268extern errno_t async_req_5_1(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
269 sysarg_t, sysarg_t, sysarg_t, sysarg_t *);
270extern errno_t async_req_5_2(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
271 sysarg_t, sysarg_t, sysarg_t, sysarg_t *, sysarg_t *);
272extern errno_t async_req_5_3(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
273 sysarg_t, sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *);
274extern errno_t async_req_5_4(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
275 sysarg_t, sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *,
276 sysarg_t *);
277extern errno_t async_req_5_5(async_exch_t *, sysarg_t, sysarg_t, sysarg_t,
278 sysarg_t, sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *,
279 sysarg_t *, sysarg_t *);
280
281extern errno_t async_accept_0(ipc_call_t *);
282extern sysarg_t async_get_label(void);
283
284extern async_sess_t *async_connect_me_to(async_exch_t *, iface_t, sysarg_t,
285 sysarg_t, errno_t *);
286extern async_sess_t *async_connect_me_to_blocking(async_exch_t *, iface_t,
287 sysarg_t, sysarg_t, errno_t *);
288extern async_sess_t *async_connect_kbox(task_id_t, errno_t *);
289
290extern errno_t async_connect_to_me(async_exch_t *, iface_t, sysarg_t, sysarg_t);
291
292extern void async_hangup(async_sess_t *);
293
294extern async_exch_t *async_exchange_begin(async_sess_t *);
295extern void async_exchange_end(async_exch_t *);
296
297/*
298 * FIXME These functions just work around problems with parallel exchange
299 * management. Proper solution needs to be implemented.
300 */
301extern void async_sess_args_set(async_sess_t *, iface_t, sysarg_t, sysarg_t);
302
303/*
304 * User-friendly wrappers for async_share_in_start().
305 */
306
307extern errno_t async_share_in_start_0_0(async_exch_t *, size_t, void **);
308extern errno_t async_share_in_start_0_1(async_exch_t *, size_t,
309 unsigned int *, void **);
310extern errno_t async_share_in_start_1_0(async_exch_t *, size_t, sysarg_t,
311 void **);
312extern errno_t async_share_in_start_1_1(async_exch_t *, size_t, sysarg_t,
313 unsigned int *, void **);
314
315extern bool async_share_in_receive(ipc_call_t *, size_t *);
316extern errno_t async_share_in_finalize(ipc_call_t *, void *, unsigned int);
317
318extern errno_t async_share_out_start(async_exch_t *, void *, unsigned int);
319extern bool async_share_out_receive(ipc_call_t *, size_t *, unsigned int *);
320extern errno_t async_share_out_finalize(ipc_call_t *, void **);
321
322extern errno_t async_data_read_forward_0_0(async_exch_t *, sysarg_t);
323extern errno_t async_data_read_forward_1_0(async_exch_t *, sysarg_t, sysarg_t);
324extern errno_t async_data_read_forward_2_0(async_exch_t *, sysarg_t, sysarg_t,
325 sysarg_t);
326extern errno_t async_data_read_forward_3_0(async_exch_t *, sysarg_t, sysarg_t,
327 sysarg_t, sysarg_t);
328extern errno_t async_data_read_forward_4_0(async_exch_t *, sysarg_t, sysarg_t,
329 sysarg_t, sysarg_t, sysarg_t);
330
331extern errno_t async_data_read_forward_0_1(async_exch_t *, sysarg_t,
332 ipc_call_t *);
333extern errno_t async_data_read_forward_1_1(async_exch_t *, sysarg_t, sysarg_t,
334 ipc_call_t *);
335extern errno_t async_data_read_forward_2_1(async_exch_t *, sysarg_t, sysarg_t,
336 sysarg_t, ipc_call_t *);
337extern errno_t async_data_read_forward_3_1(async_exch_t *, sysarg_t, sysarg_t,
338 sysarg_t, sysarg_t, ipc_call_t *);
339extern errno_t async_data_read_forward_4_1(async_exch_t *, sysarg_t, sysarg_t,
340 sysarg_t, sysarg_t, sysarg_t, ipc_call_t *);
341
342extern aid_t async_data_read(async_exch_t *, void *, size_t, ipc_call_t *);
343extern errno_t async_data_read_start(async_exch_t *, void *, size_t);
344extern bool async_data_read_receive(ipc_call_t *, size_t *);
345extern errno_t async_data_read_finalize(ipc_call_t *, const void *, size_t);
346
347extern errno_t async_data_write_forward_0_0(async_exch_t *, sysarg_t);
348extern errno_t async_data_write_forward_1_0(async_exch_t *, sysarg_t, sysarg_t);
349extern errno_t async_data_write_forward_2_0(async_exch_t *, sysarg_t, sysarg_t,
350 sysarg_t);
351extern errno_t async_data_write_forward_3_0(async_exch_t *, sysarg_t, sysarg_t,
352 sysarg_t, sysarg_t);
353extern errno_t async_data_write_forward_4_0(async_exch_t *, sysarg_t, sysarg_t,
354 sysarg_t, sysarg_t, sysarg_t);
355
356extern errno_t async_data_write_forward_0_1(async_exch_t *, sysarg_t,
357 ipc_call_t *);
358extern errno_t async_data_write_forward_1_1(async_exch_t *, sysarg_t, sysarg_t,
359 ipc_call_t *);
360extern errno_t async_data_write_forward_2_1(async_exch_t *, sysarg_t, sysarg_t,
361 sysarg_t, ipc_call_t *);
362extern errno_t async_data_write_forward_3_1(async_exch_t *, sysarg_t, sysarg_t,
363 sysarg_t, sysarg_t, ipc_call_t *);
364extern errno_t async_data_write_forward_4_1(async_exch_t *, sysarg_t, sysarg_t,
365 sysarg_t, sysarg_t, sysarg_t, ipc_call_t *);
366
367extern errno_t async_data_write_start(async_exch_t *, const void *, size_t);
368extern bool async_data_write_receive(ipc_call_t *, size_t *);
369extern errno_t async_data_write_finalize(ipc_call_t *, void *, size_t);
370
371extern errno_t async_data_write_accept(void **, const bool, const size_t,
372 const size_t, const size_t, size_t *);
373extern void async_data_write_void(errno_t);
374
375extern async_sess_t *async_callback_receive(exch_mgmt_t);
376extern async_sess_t *async_callback_receive_start(exch_mgmt_t, ipc_call_t *);
377
378extern errno_t async_state_change_start(async_exch_t *, sysarg_t, sysarg_t,
379 sysarg_t, async_exch_t *);
380extern bool async_state_change_receive(ipc_call_t *);
381extern errno_t async_state_change_finalize(ipc_call_t *, async_exch_t *);
382
383extern void *async_remote_state_acquire(async_sess_t *);
384extern void async_remote_state_update(async_sess_t *, void *);
385extern void async_remote_state_release(async_sess_t *);
386extern void async_remote_state_release_exchange(async_exch_t *);
387
388extern void *async_as_area_create(void *, size_t, unsigned int, async_sess_t *,
389 sysarg_t, sysarg_t, sysarg_t);
390
391errno_t async_spawn_notification_handler(void);
392
393#endif
394
395/** @}
396 */
Note: See TracBrowser for help on using the repository browser.