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

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

Provide means of obtaining one's own client data.

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