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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 11bb813 was 11bb813, checked in by Jakub Jermar <jakub@…>, 14 years ago

Cleanup async.h.

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