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

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

libc: do not intermix low-level IPC methods with async framework methods

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