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

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

Merge mainline changes

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