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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since fc5f7a8 was fc5f7a8, checked in by Martin Decky <martin@…>, 14 years ago

move async_init(void) into the private header

  • Property mode set to 100644
File size: 17.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#if ((defined(LIBC_IPC_H_)) && (!defined(LIBC_ASYNC_C_)))
36 #error Do not intermix low-level IPC interface and async framework
37#endif
38
39#ifndef LIBC_ASYNC_H_
40#define LIBC_ASYNC_H_
41
42#include <ipc/common.h>
43#include <async_sess.h>
44#include <fibril.h>
45#include <sys/time.h>
46#include <atomic.h>
47#include <bool.h>
48#include <task.h>
49
50typedef ipc_callid_t aid_t;
51
52typedef void *(*async_client_data_ctor_t)(void);
53typedef void (*async_client_data_dtor_t)(void *);
54
55typedef void (*async_client_conn_t)(ipc_callid_t, ipc_call_t *);
56
57extern atomic_t threads_in_ipc_wait;
58
59extern ipc_callid_t async_get_call_timeout(ipc_call_t *, suseconds_t);
60
61static inline ipc_callid_t async_get_call(ipc_call_t *data)
62{
63 return async_get_call_timeout(data, 0);
64}
65
66static inline void async_manager(void)
67{
68 fibril_switch(FIBRIL_TO_MANAGER);
69}
70
71/*
72 * User-friendly wrappers for async_send_fast() and async_send_slow(). The
73 * macros are in the form async_send_m(), where m denotes the number of payload
74 * arguments. Each macros chooses between the fast and the slow version based
75 * on m.
76 */
77
78#define async_send_0(phoneid, method, dataptr) \
79 async_send_fast((phoneid), (method), 0, 0, 0, 0, (dataptr))
80#define async_send_1(phoneid, method, arg1, dataptr) \
81 async_send_fast((phoneid), (method), (arg1), 0, 0, 0, (dataptr))
82#define async_send_2(phoneid, method, arg1, arg2, dataptr) \
83 async_send_fast((phoneid), (method), (arg1), (arg2), 0, 0, (dataptr))
84#define async_send_3(phoneid, method, arg1, arg2, arg3, dataptr) \
85 async_send_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (dataptr))
86#define async_send_4(phoneid, method, arg1, arg2, arg3, arg4, dataptr) \
87 async_send_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
88 (dataptr))
89#define async_send_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, dataptr) \
90 async_send_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
91 (arg5), (dataptr))
92
93extern aid_t async_send_fast(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
94 sysarg_t, ipc_call_t *);
95extern aid_t async_send_slow(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
96 sysarg_t, sysarg_t, ipc_call_t *);
97extern void async_wait_for(aid_t, sysarg_t *);
98extern int async_wait_timeout(aid_t, sysarg_t *, suseconds_t);
99
100extern fid_t async_new_connection(sysarg_t, sysarg_t, ipc_callid_t,
101 ipc_call_t *, void (*)(ipc_callid_t, ipc_call_t *));
102extern void async_usleep(suseconds_t);
103extern void async_create_manager(void);
104extern void async_destroy_manager(void);
105
106extern void async_set_client_data_constructor(async_client_data_ctor_t);
107extern void async_set_client_data_destructor(async_client_data_dtor_t);
108
109extern void *async_client_data_get(void);
110
111extern void async_set_client_connection(async_client_conn_t);
112extern void async_set_interrupt_received(async_client_conn_t);
113
114/*
115 * Wrappers for simple communication.
116 */
117
118extern void async_msg_0(int, sysarg_t);
119extern void async_msg_1(int, sysarg_t, sysarg_t);
120extern void async_msg_2(int, sysarg_t, sysarg_t, sysarg_t);
121extern void async_msg_3(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t);
122extern void async_msg_4(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t, sysarg_t);
123extern void async_msg_5(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
124 sysarg_t);
125
126/*
127 * Wrappers for answer routines.
128 */
129
130extern sysarg_t async_answer_0(ipc_callid_t, sysarg_t);
131extern sysarg_t async_answer_1(ipc_callid_t, sysarg_t, sysarg_t);
132extern sysarg_t async_answer_2(ipc_callid_t, sysarg_t, sysarg_t, sysarg_t);
133extern sysarg_t async_answer_3(ipc_callid_t, sysarg_t, sysarg_t, sysarg_t,
134 sysarg_t);
135extern sysarg_t async_answer_4(ipc_callid_t, sysarg_t, sysarg_t, sysarg_t,
136 sysarg_t, sysarg_t);
137extern sysarg_t async_answer_5(ipc_callid_t, sysarg_t, sysarg_t, sysarg_t,
138 sysarg_t, sysarg_t, sysarg_t);
139
140/*
141 * Wrappers for forwarding routines.
142 */
143
144extern int async_forward_fast(ipc_callid_t, int, int, sysarg_t, sysarg_t, int);
145extern int async_forward_slow(ipc_callid_t, int, int, sysarg_t, sysarg_t,
146 sysarg_t, sysarg_t, sysarg_t, int);
147
148/*
149 * User-friendly wrappers for async_req_fast() and async_req_slow(). The macros
150 * are in the form async_req_m_n(), where m is the number of payload arguments
151 * and n is the number of return arguments. The macros decide between the fast
152 * and slow verion based on m.
153 */
154
155#define async_req_0_0(phoneid, method) \
156 async_req_fast((phoneid), (method), 0, 0, 0, 0, NULL, NULL, NULL, NULL, \
157 NULL)
158#define async_req_0_1(phoneid, method, r1) \
159 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), NULL, NULL, NULL, \
160 NULL)
161#define async_req_0_2(phoneid, method, r1, r2) \
162 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), NULL, NULL, \
163 NULL)
164#define async_req_0_3(phoneid, method, r1, r2, r3) \
165 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), (r3), NULL, \
166 NULL)
167#define async_req_0_4(phoneid, method, r1, r2, r3, r4) \
168 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), (r3), (r4), \
169 NULL)
170#define async_req_0_5(phoneid, method, r1, r2, r3, r4, r5) \
171 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), (r3), (r4), \
172 (r5))
173#define async_req_1_0(phoneid, method, arg1) \
174 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, NULL, NULL, NULL, \
175 NULL, NULL)
176#define async_req_1_1(phoneid, method, arg1, rc1) \
177 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), NULL, NULL, \
178 NULL, NULL)
179#define async_req_1_2(phoneid, method, arg1, rc1, rc2) \
180 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), NULL, \
181 NULL, NULL)
182#define async_req_1_3(phoneid, method, arg1, rc1, rc2, rc3) \
183 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), (rc3), \
184 NULL, NULL)
185#define async_req_1_4(phoneid, method, arg1, rc1, rc2, rc3, rc4) \
186 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), (rc3), \
187 (rc4), NULL)
188#define async_req_1_5(phoneid, method, arg1, rc1, rc2, rc3, rc4, rc5) \
189 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), (rc3), \
190 (rc4), (rc5))
191#define async_req_2_0(phoneid, method, arg1, arg2) \
192 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, NULL, NULL, \
193 NULL, NULL, NULL)
194#define async_req_2_1(phoneid, method, arg1, arg2, rc1) \
195 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), NULL, \
196 NULL, NULL, NULL)
197#define async_req_2_2(phoneid, method, arg1, arg2, rc1, rc2) \
198 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
199 NULL, NULL, NULL)
200#define async_req_2_3(phoneid, method, arg1, arg2, rc1, rc2, rc3) \
201 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
202 (rc3), NULL, NULL)
203#define async_req_2_4(phoneid, method, arg1, arg2, rc1, rc2, rc3, rc4) \
204 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
205 (rc3), (rc4), NULL)
206#define async_req_2_5(phoneid, method, arg1, arg2, rc1, rc2, rc3, rc4, rc5) \
207 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
208 (rc3), (rc4), (rc5))
209#define async_req_3_0(phoneid, method, arg1, arg2, arg3) \
210 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, NULL, NULL, \
211 NULL, NULL, NULL)
212#define async_req_3_1(phoneid, method, arg1, arg2, arg3, rc1) \
213 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
214 NULL, NULL, NULL, NULL)
215#define async_req_3_2(phoneid, method, arg1, arg2, arg3, rc1, rc2) \
216 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
217 (rc2), NULL, NULL, NULL)
218#define async_req_3_3(phoneid, method, arg1, arg2, arg3, rc1, rc2, rc3) \
219 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
220 (rc2), (rc3), NULL, NULL)
221#define async_req_3_4(phoneid, method, arg1, arg2, arg3, rc1, rc2, rc3, rc4) \
222 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
223 (rc2), (rc3), (rc4), NULL)
224#define async_req_3_5(phoneid, method, arg1, arg2, arg3, rc1, rc2, rc3, rc4, \
225 rc5) \
226 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
227 (rc2), (rc3), (rc4), (rc5))
228#define async_req_4_0(phoneid, method, arg1, arg2, arg3, arg4) \
229 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), NULL, \
230 NULL, NULL, NULL, NULL)
231#define async_req_4_1(phoneid, method, arg1, arg2, arg3, arg4, rc1) \
232 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), (rc1), \
233 NULL, NULL, NULL, NULL)
234#define async_req_4_2(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2) \
235 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), (rc1), \
236 (rc2), NULL, NULL, NULL)
237#define async_req_4_3(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2, rc3) \
238 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), (rc1), \
239 (rc2), (rc3), NULL, NULL)
240#define async_req_4_4(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2, rc3, \
241 rc4) \
242 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
243 (rc1), (rc2), (rc3), (rc4), NULL)
244#define async_req_4_5(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2, rc3, \
245 rc4, rc5) \
246 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
247 (rc1), (rc2), (rc3), (rc4), (rc5))
248#define async_req_5_0(phoneid, method, arg1, arg2, arg3, arg4, arg5) \
249 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
250 (arg5), NULL, NULL, NULL, NULL, NULL)
251#define async_req_5_1(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1) \
252 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
253 (arg5), (rc1), NULL, NULL, NULL, NULL)
254#define async_req_5_2(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2) \
255 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
256 (arg5), (rc1), (rc2), NULL, NULL, NULL)
257#define async_req_5_3(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2, \
258 rc3) \
259 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
260 (arg5), (rc1), (rc2), (rc3), NULL, NULL)
261#define async_req_5_4(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2, \
262 rc3, rc4) \
263 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
264 (arg5), (rc1), (rc2), (rc3), (rc4), NULL)
265#define async_req_5_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2, \
266 rc3, rc4, rc5) \
267 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
268 (arg5), (rc1), (rc2), (rc3), (rc4), (rc5))
269
270extern sysarg_t async_req_fast(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
271 sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *);
272extern sysarg_t async_req_slow(int, sysarg_t, sysarg_t, sysarg_t, sysarg_t,
273 sysarg_t, sysarg_t, sysarg_t *, sysarg_t *, sysarg_t *, sysarg_t *,
274 sysarg_t *);
275
276static inline void async_serialize_start(void)
277{
278 fibril_inc_sercount();
279}
280
281static inline void async_serialize_end(void)
282{
283 fibril_dec_sercount();
284}
285
286extern int async_connect_to_me(int, sysarg_t, sysarg_t, sysarg_t,
287 async_client_conn_t);
288extern int async_connect_me_to(int, sysarg_t, sysarg_t, sysarg_t);
289extern int async_connect_me_to_blocking(int, sysarg_t, sysarg_t, sysarg_t);
290extern int async_connect_kbox(task_id_t);
291extern int async_hangup(int);
292extern void async_poke(void);
293
294/*
295 * User-friendly wrappers for async_share_in_start().
296 */
297
298#define async_share_in_start_0_0(phoneid, dst, size) \
299 async_share_in_start((phoneid), (dst), (size), 0, NULL)
300#define async_share_in_start_0_1(phoneid, dst, size, flags) \
301 async_share_in_start((phoneid), (dst), (size), 0, (flags))
302#define async_share_in_start_1_0(phoneid, dst, size, arg) \
303 async_share_in_start((phoneid), (dst), (size), (arg), NULL)
304#define async_share_in_start_1_1(phoneid, dst, size, arg, flags) \
305 async_share_in_start((phoneid), (dst), (size), (arg), (flags))
306
307extern int async_share_in_start(int, void *, size_t, sysarg_t, int *);
308extern int async_share_in_receive(ipc_callid_t *, size_t *);
309extern int async_share_in_finalize(ipc_callid_t, void *, int );
310extern int async_share_out_start(int, void *, int);
311extern int async_share_out_receive(ipc_callid_t *, size_t *, int *);
312extern int async_share_out_finalize(ipc_callid_t, void *);
313
314/*
315 * User-friendly wrappers for async_data_read_forward_fast().
316 */
317
318#define async_data_read_forward_0_0(phoneid, method, answer) \
319 async_data_read_forward_fast((phoneid), (method), 0, 0, 0, 0, NULL)
320#define async_data_read_forward_0_1(phoneid, method, answer) \
321 async_data_read_forward_fast((phoneid), (method), 0, 0, 0, 0, (answer))
322#define async_data_read_forward_1_0(phoneid, method, arg1, answer) \
323 async_data_read_forward_fast((phoneid), (method), (arg1), 0, 0, 0, NULL)
324#define async_data_read_forward_1_1(phoneid, method, arg1, answer) \
325 async_data_read_forward_fast((phoneid), (method), (arg1), 0, 0, 0, (answer))
326#define async_data_read_forward_2_0(phoneid, method, arg1, arg2, answer) \
327 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, NULL)
328#define async_data_read_forward_2_1(phoneid, method, arg1, arg2, answer) \
329 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
330 (answer))
331#define async_data_read_forward_3_0(phoneid, method, arg1, arg2, arg3, answer) \
332 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, \
333 NULL)
334#define async_data_read_forward_3_1(phoneid, method, arg1, arg2, arg3, answer) \
335 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, \
336 (answer))
337#define async_data_read_forward_4_0(phoneid, method, arg1, arg2, arg3, arg4, answer) \
338 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
339 (arg4), NULL)
340#define async_data_read_forward_4_1(phoneid, method, arg1, arg2, arg3, arg4, answer) \
341 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
342 (arg4), (answer))
343
344extern int async_data_read_start(int, void *, size_t);
345extern int async_data_read_receive(ipc_callid_t *, size_t *);
346extern int async_data_read_finalize(ipc_callid_t, const void *, size_t);
347
348extern int async_data_read_forward_fast(int, sysarg_t, sysarg_t, sysarg_t,
349 sysarg_t, sysarg_t, ipc_call_t *);
350
351/*
352 * User-friendly wrappers for async_data_write_forward_fast().
353 */
354
355#define async_data_write_forward_0_0(phoneid, method, answer) \
356 async_data_write_forward_fast((phoneid), (method), 0, 0, 0, 0, NULL)
357#define async_data_write_forward_0_1(phoneid, method, answer) \
358 async_data_write_forward_fast((phoneid), (method), 0, 0, 0, 0, (answer))
359#define async_data_write_forward_1_0(phoneid, method, arg1, answer) \
360 async_data_write_forward_fast((phoneid), (method), (arg1), 0, 0, 0, NULL)
361#define async_data_write_forward_1_1(phoneid, method, arg1, answer) \
362 async_data_write_forward_fast((phoneid), (method), (arg1), 0, 0, 0, \
363 (answer))
364#define async_data_write_forward_2_0(phoneid, method, arg1, arg2, answer) \
365 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
366 NULL)
367#define async_data_write_forward_2_1(phoneid, method, arg1, arg2, answer) \
368 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
369 (answer))
370#define async_data_write_forward_3_0(phoneid, method, arg1, arg2, arg3, answer) \
371 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
372 0, NULL)
373#define async_data_write_forward_3_1(phoneid, method, arg1, arg2, arg3, answer) \
374 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
375 0, (answer))
376#define async_data_write_forward_4_0(phoneid, method, arg1, arg2, arg3, arg4, answer) \
377 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
378 (arg4), NULL)
379#define async_data_write_forward_4_1(phoneid, method, arg1, arg2, arg3, arg4, answer) \
380 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
381 (arg4), (answer))
382
383extern int async_data_write_start(int, const void *, size_t);
384extern int async_data_write_receive(ipc_callid_t *, size_t *);
385extern int async_data_write_finalize(ipc_callid_t, void *, size_t);
386
387extern int async_data_write_accept(void **, const bool, const size_t,
388 const size_t, const size_t, size_t *);
389extern void async_data_write_void(const int);
390
391extern int async_data_write_forward_fast(int, sysarg_t, sysarg_t, sysarg_t,
392 sysarg_t, sysarg_t, ipc_call_t *);
393
394#endif
395
396/** @}
397 */
Note: See TracBrowser for help on using the repository browser.